メッセージ (Windows Web サービス)
メッセージは、送受信されるデータをカプセル化するオブジェクトです。 メッセージの構造は SOAP によって定義され、ヘッダーと本文のセットが含まれます。 ヘッダーは常にメモリにバッファーされますが、本文は読み取られ、ストリーミング API で書き込まれます。
メッセージには、メッセージの動作を制御するオプションの設定を指定したり、受信したメッセージに関する追加情報 (セキュリティ情報など) を取得したりするために使用できる一連のプロパティがあります。 メッセージ のプロパティの完全な一覧については、「WS_MESSAGE_PROPERTY_ID」を参照してください。
メッセージは、特定の エンドポイント アドレスにアドレス指定されます。
WS_FAULT は、リモート エンドポイントから返されたエラーを表すために使用される特別な種類のメッセージ コンテンツです。
メッセージは、送信される前に XML を線形ワイヤー形式に変換するエンコードを受けます。
メッセージの詳細については、「チャネル レイヤーの概要」 トピックを参照してください。
次の例は、WWSAPI でのメッセージの使用を示しています。
| 例 | 形容 |
|---|---|
| CustomHeaderExample の | カスタム メッセージ ヘッダーの使用を示します。 |
| MessageEncodingExample | メッセージのエンコードとデコードを示します。 |
| ForwardMessageExample | メッセージの転送を示します。 |
次の API 要素は、メッセージと共に使用されます。
| コールバック | 形容 |
|---|---|
| WS_MESSAGE_DONE_CALLBACK | メッセージが WsReadEnvelopeStart 関数に提供されたWS_XML_READER構造体、または WsWriteEnvelopeStart 関数に提供されたWS_XML_WRITER構造体の使用を完了したことを呼び出し元に通知します。 |
| 列挙 | 形容 |
|---|---|
| WS_ADDRESSING_VERSION | アドレス指定ヘッダーに使用される仕様のバージョン。 |
| WS_ENVELOPE_VERSION | エンベロープ構造に使用される仕様のバージョン。 |
| WS_HEADER_ATTRIBUTES | ヘッダーの SOAP mustUnderstand 属性と Relay 属性を表すフラグのセット。 |
| WS_HEADER_TYPE | ヘッダーの型。 |
| WS_MESSAGE_INITIALIZATION | WsInitializeMessage がメッセージに追加するヘッダーを指定します。 |
| WS_MESSAGE_PROPERTY_ID | 各メッセージ プロパティの ID。 |
| WS_MESSAGE_STATE | メッセージの状態。 |
| 機能 | 形容 |
|---|---|
| WsAddressMessageの | 宛先アドレスをメッセージに割り当てます。 |
| WsCheckMustUnderstandHeadersの | 指定したヘッダーが受信側によって適切に認識されたことを確認します。 |
| WsCreateMessageの | WS_MESSAGE オブジェクトのインスタンスを作成します。 |
| WsCreateMessageForChannelの | 特定のチャネルでの使用に適したメッセージを作成します。 |
| WsFillBodyの | メッセージの読み取りに十分なバイト数が使用可能であることを確認します。 |
| WsFlushBodyの | 書き込まれたすべての蓄積されたメッセージ本文データをフラッシュします。 |
| WsFreeMessageの | メッセージに関連付けられているメモリ リソースを解放します。 |
| WsGetCustomHeaderの | メッセージのアプリケーション定義ヘッダーを検索し、逆シリアル化します。 |
| WsGetHeaderの | メッセージ内の特定の標準ヘッダーを検索し、逆シリアル化します。 |
| WsGetHeaderAttributesの | ULONG パラメーターに、リーダーが配置されているヘッダー要素の WS_HEADER_ATTRIBUTES を設定します。 |
| WsGetMessagePropertyの | 指定した Message オブジェクト プロパティを取得します。 |
| WsInitializeMessageの | 処理の準備としてメッセージのヘッダーを初期化します。 |
| WsMarkHeaderAsUnderstood | アプリケーションによって認識されるようにヘッダーをマークします。 |
| WsReadBodyの | メッセージの XML リーダーから値を逆シリアル化します。 |
| WsReadEnvelopeEndの | メッセージの終了要素を読み取ります。 |
| WsReadEnvelopeStartの | メッセージのヘッダーを読み取り、本文要素を読み取る準備をします。 |
| WsRemoveCustomHeaderの | メッセージからカスタム ヘッダーを削除します。 |
| WsRemoveHeaderの | メッセージから標準 WS_HEADER_TYPE オブジェクトを削除します。 |
| WsResetMessageの | メッセージの状態を WS_MESSAGE_STATE_EMPTYに戻します。 |
| WsSetHeaderの | メッセージ内の指定した標準ヘッダーを追加または置換します。 |
| WsWriteBodyの | メッセージの本文に値を書き込みます。 |
| WsWriteEnvelopeEndの | メッセージの終了要素を書き込みます。 |
| WsWriteEnvelopeStartの | メッセージの現在のヘッダー セットを含むメッセージの先頭を書き込み、本文要素を書き込む準備をします。 |
| ハンドル | 形容 |
|---|---|
| WS_MESSAGE | メッセージ オブジェクトを参照するために使用される不透明な型。 |
| 構造 | 形容 |
|---|---|
| WS_FAULT | 処理エラーを示すメッセージの本文に含まれるエラー値。 |
| WS_FAULT_CODE | エラー コードを表します。 |
| WS_FAULT_REASON | エラーの説明が含まれています。 |
| WS_MESSAGE_PROPERTIES | WS_MESSAGE_PROPERTY 構造体のセットを指定します。 |
| WS_MESSAGE_PROPERTY | メッセージ固有の設定を指定します。 |