WsGetHeader 関数 (webservices.h)

  • [アーティクル]

メッセージ内の特定の標準ヘッダーを検索し、逆シリアル化します。

構文

HRESULT WsGetHeader(
  [in]           WS_MESSAGE     *message,
  [in]           WS_HEADER_TYPE headerType,
  [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] headerType

逆シリアル化するヘッダーの型。

[in] valueType

逆シリアル化する値の型。 ヘッダー の 各型に対応する型のセットについては、「WS_HEADER_TYPE」を参照してください。

[in] readOption

値が必要かどうか、および値を割り当てる方法。 WS_HEADER_TYPEのヘッダーの種類は、それぞれの標準仕様では実行できないため、WS_READ_NILLABLE_VALUEおよびWS_READ_NILLABLE_POINTER読み取りオプションを指定できません。 詳細については、「 WS_READ_OPTION 」を参照してください。

[in, optional] heap

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

value

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

[in] valueSize

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

[in, optional] error

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

戻り値

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

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

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

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

注釈

この API は、一連の標準ヘッダー型へのアクセスを提供します ( WS_HEADER_TYPEを参照)。 アプリケーション定義のヘッダー型の場合は、 WsGetCustomHeader を使用します。

この API は、メッセージに 1 回表示され、最終的な受信者を対象とするヘッダーの種類を処理するように設計されています。 この API では、最終的なレシーバー以外のロール/アクターを対象とするヘッダーは無視されます。

要件

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