Soap.InvokeRegistry.TInvokableClassRegistry.RegisterHeaderClass

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

procedure RegisterHeaderClass(Info: PTypeInfo; AClass: TClass;  const HeaderName: InvString; const HeaderNamespace: InvString; DefaultMethodType: eHeaderMethodType = hmtAll; Required: Boolean = False); overload;
procedure RegisterHeaderClass(Info: PTypeInfo; AClass: TClass;  DefaultMethodType: eHeaderMethodType = hmtAll; Required: Boolean = False); overload;

C++

void __fastcall RegisterHeaderClass(System::Typinfo::PTypeInfo Info, System::TClass AClass, const System::UnicodeString HeaderName, const System::UnicodeString HeaderNamespace, eHeaderMethodType DefaultMethodType = (eHeaderMethodType)(0x0), bool Required = false)/* overload */;
void __fastcall RegisterHeaderClass(System::Typinfo::PTypeInfo Info, System::TClass AClass, eHeaderMethodType DefaultMethodType = (eHeaderMethodType)(0x0), bool Required = false)/* overload */;

プロパティ

種類 可視性 ソース ユニット
procedure
function
public
Soap.InvokeRegistry.pas
Soap.InvokeRegistry.hpp
Soap.InvokeRegistry TInvokableClassRegistry

説明

起動可能なインターフェースの呼び出しを含むヘッダーを表すクラスを登録します。

TSOAPHeader の下位クラスを登録するには,RegisterHeaderClass を使用します。TSOAPHeader の下位クラスを登録することには,次の 2 つの目的があります。

サーバーにおいて,TSOAPHeader の下位クラスが登録されると,その定義が WSDL ドキュメントにエクスポートされるめ,その WSDL を使用しているアプリケーションはそのヘッダーを認識して処理することができます。

サーバーとクライアントの両方において,登録が行われると,TSOAPHeader の下位クラスにヘッダー名とその名前が定義された名前空間を関連付けます。

Info は,そのヘッダーに含めるインターフェースの型情報を指し示します。複数のインターフェースを起動するメッセージまたは複数のインターフェースに対する応答にそのヘッダーを含める場合,このメソッドを各インターフェース型につき 1 回呼び出す必要があります。

AClass は,そのヘッダーを表す TSOAPHeader の下位クラスを説明します。

HeaderName は,そのヘッダーの名前空間で定義されているヘッダー名です。HeaderName が提供されていない場合,ヘッダー名は,そのヘッダーがリモート可能な型レジストリで登録されたときに型名として提供された名前と同じであるとみなされます。

HeaderNamespace は,そのヘッダーの名前が定義されている名前空間の URI です。HeaderName と HeaderNamespace が提供されていない場合,ヘッダーは,それが関連付けられたインターフェースと同じ名前空間で定義されているものとみなされます。

DefaultMethodType は,そのヘッダーをリクエストメッセージとレスポンスメッセージのどちらで使用するのか,または両方で使用するのかを示します。このデフォルト値は,インターフェース全体に関連付けられます。これは,後で RegisterHeaderMethod メソッドを呼び出すことによって,インターフェースの個々のメソッドについて変更できます。

Required は,インターフェースに関するメッセージにそのヘッダーを含める必要があるかどうかを示します。Required が true のとき,そのヘッダーは,含める必要があり,受取人に伝わる必要があります。Required が false のとき,そのヘッダーは省略可能です。そのヘッダーが一部のメッセージに必要であってもすべてのメッセージには必要ない場合,この Required パラメータは false に設定し,その後で RegisterHeaderMethod メソッドを呼び出すことによって個々のメソッドに必須であることを設定する必要があります。

メモ:  RegisterHeaderClass に対する呼び出しの後で,そのヘッダークラスは,指定されたインターフェースのすべてのメソッドに関連付けられるように,登録されます。そのインターフェースの一部のメソッドだけがこのヘッダーを使用する場合,そのインターフェースの一部のメソッドについて異なるメソッド型をそのヘッダーが含む必要がある場合,またはそのインターフェースの一部のメソッドでそのヘッダーが必要である場合は,そのヘッダーが含むメソッドのそれぞれについて RegisterHeaderMethod メソッドを呼び出すことによってそのことを示すことができます。

関連項目