WsGetCustomHeader 関数 (webservices.h)

  • [アーティクル]

メッセージのアプリケーション定義ヘッダーを検索し、逆シリアル化します。

構文

HRESULT WsGetCustomHeader(
  [in]           WS_MESSAGE                   *message,
  [in]           const WS_ELEMENT_DESCRIPTION *customHeaderDescription,
  [in]           WS_REPEATING_HEADER_OPTION   repeatingOption,
  [in]           ULONG                        headerIndex,
  [in]           WS_READ_OPTION               readOption,
  [in, optional] WS_HEAP                      *heap,
                 void                         *value,
  [in]           ULONG                        valueSize,
                 ULONG                        *headerAttributes,
  [in, optional] WS_ERROR                     *error
);

パラメーター

[in] message

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

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

[in] customHeaderDescription

ヘッダー要素を記述する WS_ELEMENT_DESCRIPTION 。

[in] repeatingOption

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

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

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

[in] headerIndex

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

[in] readOption

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

[in, optional] heap

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

value

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

[in] valueSize

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

headerAttributes

このヘッダーの WS_HEADER_ATTRIBUTES を返します。 ポインターは NULL である可能性があります。この場合、属性は返されません。

[in, optional] error

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

戻り値

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

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

WS_SINGLETON_HEADER が指定され、メッセージに存在するヘッダーの種類の複数のインスタンスがあります。

入力データの形式が正しくありません。
WS_E_QUOTA_EXCEEDED
 ヒープのサイズ クォータを超えました。
E_OUTOFMEMORY
 ヘッダーを逆シリアル化するのに十分なメモリが不足していました。
E_INVALIDARG
 1 つ以上のパラメーターが正しくありません。
その他のエラー
この関数は、上記以外のエラーを返す場合があります。

解説

この API は、最終的なレシーバーを対象とするヘッダーに対して動作します。
この API では、最終的なレシーバー以外のロール/アクターを対象とするヘッダーは無視されます。

要件

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