Share via

WsGetMappedHeader 関数 (webservices.h)

  • [アーティクル]

メッセージ内のマップされたヘッダーを検索し、逆シリアル化します。

構文

HRESULT WsGetMappedHeader(
  [in]           WS_MESSAGE                 *message,
  [in]           const WS_XML_STRING        *headerName,
  [in]           WS_REPEATING_HEADER_OPTION repeatingOption,
  [in]           ULONG                      headerIndex,
  [in]           WS_TYPE                    valueType,
  [in]           WS_READ_OPTION             readOption,
  [in, optional] WS_HEAP                    *heap,
                 void                       *value,
  [in]           ULONG                      valueSize,
  [in, optional] WS_ERROR                   *error
);

パラメーター

[in] message

ヘッダーを含むメッセージ。

メッセージは、 WS_MESSAGE_STATE_EMPTY以外の任意の状態にすることができます。

[in] headerName

マップされたヘッダーの名前。

[in] repeatingOption

ヘッダーがメッセージに複数回表示されるかどうか。

WS_REPEATING_HEADERが使用されている場合、ヘッダー インデックスは、指定した headerName を持つヘッダーのうち、返すヘッダーを示します。

WS_SINGLETON_HEADERを使用する場合、headerIndex は 0 である必要があります。

[in] headerIndex

指定した headerName を持つヘッダーのセット内のヘッダーの 0 から始まるインデックス。

[in] valueType

逆シリアル化する値の型。

[in] readOption

値が必要かどうか、および値を割り当てる方法。 詳細については、「 WS_READ_OPTION 」を参照してください。

ヘッダーが省略可能な場合 (0 回または 1 回表示される場合があります)、 WS_READ_OPTIONAL_POINTER を使用できます。

[in, optional] heap

逆シリアル化されたヘッダー データを格納するヒープ。 これが NULL の場合、メッセージ ヒープが使用されます。

value

このパラメーターの解釈は 、WS_READ_OPTIONによって異なります。

[in] valueSize

このパラメーターの解釈は 、WS_READ_OPTIONによって異なります。

[in, optional] error

関数が失敗した場合に追加のエラー情報を格納する場所を指定します。

戻り値

この関数は、これらの値のいずれかを返すことができます。

リターン コード 説明
WS_E_INVALID_FORMAT
 ヘッダーは存在せず、必須です。

入力データの形式が正しくありません。

WS_SINGLETON_HEADER が指定され、指定した名前のヘッダーのインスタンスがメッセージに複数存在します。
WS_E_QUOTA_EXCEEDED
 ヒープのサイズ クォータを超えました。
E_OUTOFMEMORY
 ヘッダーを逆シリアル化するのに十分なメモリが不足していました。
E_INVALIDARG
 1 つ以上のパラメーターが正しくありません。
その他のエラー
この関数は、上記以外のエラーを返す場合があります。

注釈

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

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

要件

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