次の方法で共有

WsSetHeader 関数 (webservices.h)

  • [アーティクル]

メッセージ内の指定した標準ヘッダーを追加または置換します。

構文

HRESULT WsSetHeader(
  [in]           WS_MESSAGE      *message,
  [in]           WS_HEADER_TYPE  headerType,
  [in]           WS_TYPE         valueType,
  [in]           WS_WRITE_OPTION writeOption,
                 const void      *value,
  [in]           ULONG           valueSize,
  [in, optional] WS_ERROR        *error
);

パラメーター

[in] message

ヘッダーを設定するメッセージ。

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

[in] headerType

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

[in] valueType

シリアル化する値の型。 ヘッダー の種類 ごとにサポートされている型のセットについては、「WS_HEADER_TYPE」を参照してください。

[in] writeOption

ヘッダー要素が必要かどうか、および値の割り当て方法。 WS_WRITE_NILLABLE_VALUE および WS_WRITE_NILLABLE_POINTER 書き込みオプションを指定することはできません。 WS_HEADER_TYPE のヘッダーの種類は、それぞれの標準仕様では使用できないためです。 詳細については、「 WS_WRITE_OPTION 」を参照してください。

value

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

[in] valueSize

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

[in, optional] error

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

戻り値

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

リターン コード 説明
WS_E_INVALID_FORMAT
 メッセージに存在するヘッダーの種類のインスタンスが複数あります。
E_OUTOFMEMORY
 ヘッダーをシリアル化するのに十分なメモリが不足していました。
E_INVALIDARG
 1 つ以上のパラメーターが正しくありません。
その他のエラー
この関数は、上記以外のエラーを返す場合があります。

解説

この API を使用すると、標準のヘッダーの種類を設定できます ( WS_HEADER_TYPEを参照)。 アプリケーション定義のヘッダーの種類の場合は、 WsAddCustomHeader を使用します。

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

特定の型 (最終的な受信側を対象とする) のヘッダーがメッセージに既に存在する場合は、置き換えられます。

要件

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