WsAddCustomHeader 関数 (webservices.h)

  • [アーティクル]

指定したアプリケーション定義ヘッダーをメッセージに追加 します。

構文

HRESULT WsAddCustomHeader(
  [in]           WS_MESSAGE                   *message,
  [in]           const WS_ELEMENT_DESCRIPTION *headerDescription,
  [in]           WS_WRITE_OPTION              writeOption,
  [in, ref]      const void                   *value,
  [in]           ULONG                        valueSize,
  [in]           ULONG                        headerAttributes,
  [in, optional] WS_ERROR                     *error
);

パラメーター

[in] message

ヘッダーを追加するメッセージ。

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

[in] headerDescription

ヘッダー を 記述するWS_ELEMENT_DESCRIPTION構造体。

[in] writeOption

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

[in, ref] value

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

[in] valueSize

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

[in] headerAttributes

ヘッダーの SOAP 属性の値。

[in, optional] error

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

戻り値

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

リターン コード 説明
WS_E_INVALID_FORMAT
 メッセージには、同じ種類のヘッダーの複数のインスタンスが存在します。
E_OUTOFMEMORY
 操作を完了するためのメモリ不足。
E_INVALIDARG
 1 つ以上のパラメーターが正しくありません。
その他のエラー
この関数は、上記以外のエラーを返す場合があります。

注釈

WsAddCustomHeader 関数は、最終的なレシーバーを対象とするヘッダーの種類を処理するように設計されています。 別の受信者を対象とするヘッダーは無視されます。

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

要件

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