WsAddMappedHeader 関数 (webservices.h)

指定したマップされたヘッダーをメッセージに追加 します。

構文

HRESULT WsAddMappedHeader(
  [in]           WS_MESSAGE          *message,
  [in]           const WS_XML_STRING *headerName,
  [in]           WS_TYPE             valueType,
  [in]           WS_WRITE_OPTION     writeOption,
  [in]           const void          *value,
  [in]           ULONG               valueSize,
  [in, optional] WS_ERROR            *error
);

パラメーター

[in] message

マップされたヘッダーを追加するメッセージを表すWS_MESSAGE構造体へのポインター。

メッセージは、WS_MESSAGE_STATE_EMPTYを除く任意 の 状態にすることができます ( WS_MESSAGE_STATE 列挙を参照してください)。

[in] headerName

ヘッダーの名前を含む WS_XML_STRING へのポインター。

[in] valueType

逆シリアル化するヘッダー値の型。 使用可能な型と対応するヘッダーについては、WS_HEADER_TYPEを参照してください。

[in] writeOption

ヘッダーが必要かどうか、および値の割り当て方法。 詳細については、 WS_WRITE_OPTION 列挙を参照してください。

[in] value

シリアル化するヘッダー値。 詳細については、 WS_WRITE_OPTION 列挙を参照してください。

[in] valueSize

シリアル化される値のサイズ (バイト単位)。

[in, optional] error

関数が失敗した場合に追加のエラー情報を受け取る WS_ERROR 構造体へのポインター。

戻り値

関数が成功した場合は、NO_ERRORを返します。それ以外の場合は、HRESULT エラー コードを返します。

リターン コード	説明
E_OUTOFMEMORY	操作を完了するためのメモリ不足。
E_INVALIDARG	1 つ以上のパラメーターが正しくありません。
その他のエラー	この関数は、上記以外のエラーを返す場合があります。

注釈

メッセージには、メッセージ エンベロープの一部ではない追加のトランスポート固有の情報が含まれている場合があります。 このトランスポート固有の情報は、プログラムによってメッセージのヘッダーとして公開できます。 WsAddMappedHeader 関数は、トランスポート固有の場所にマップされるこのようなヘッダーを追加するために使用されます。

HTTP チャネルを使用する場合は、この関数を呼び出してヘッダーを追加する前に、必要なマッピングを指定する必要があります。 詳細については、「 WS_HTTP_MESSAGE_MAPPING」を参照してください。

ヘッダーを置き換える場合は、 WsAddMappedHeader を呼び出す前に 、WsRemoveMappedHeader 関数を呼び出してヘッダーの既存のインスタンスを削除します。

要件

要件	値
サポートされている最小のクライアント	Windows 7 [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー	Windows Server 2008 R2 [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	webservices.h
Library	WebServices.lib
[DLL]	WebServices.dll