次の方法で共有

WsRemoveHeader 関数 (webservices.h)

  • [アーティクル]

メッセージから標準 のWS_HEADER_TYPE オブジェクトを削除します。

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

アプリケーション定義ヘッダー型の場合は、 WsRemoveCustomHeader 関数を使用します。

構文

HRESULT WsRemoveHeader(
  [in]           WS_MESSAGE     *message,
  [in]           WS_HEADER_TYPE headerType,
  [in, optional] WS_ERROR       *error
);

パラメーター

[in] message

削除するヘッダーを含む Message オブジェクトへのポインター。 メッセージは、WS_MESSAGE_STATE_EMPTYを除く任意 の状態にすることができます。

[in] headerType

削除するヘッダーの種類を示します。

[in, optional] error

関数 が失敗 した場合にエラーに関する追加情報を格納する必要があるWS_ERROR オブジェクトへのポインター。

戻り値

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

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

注釈

指定された型のヘッダーがメッセージに存在する場合は、削除されます。 ヘッダーが存在しない場合、アクションは実行されず、関数は正常に完了します。

要件

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