WsRemoveCustomHeader 関数 (webservices.h)

  • [アーティクル]

メッセージからカスタム ヘッダーを削除します。

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

構文

HRESULT WsRemoveCustomHeader(
  [in]           WS_MESSAGE          *message,
  [in]           const WS_XML_STRING *headerName,
  [in]           const WS_XML_STRING *headerNs,
  [in, optional] WS_ERROR            *error
);

パラメーター

[in] message

削除するヘッダーを含む Message オブジェクトへのポインター。

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

[in] headerName

削除 するヘッダー 要素の "ローカル名" を参照するWS_XML_STRING オブジェクトへのポインター。

[in] headerNs

削除するヘッダー要素の名前空間を参照する WS_XML_STRING オブジェクトへのポインター。

[in, optional] error

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

戻り値

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

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

解説

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

要件

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