WsRemoveHeader 函式 (webservices.h)

  • 發行項

從訊息中移除標準 WS_HEADER_TYPE 物件。

函式的設計目的是要處理訊息中出現一次且以最終接收者為目標的標頭類型。 系統會忽略以最終接收者以外的角色為目標的標頭。

針對應用程式定義的標頭類型，請使用 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 物件的指標，如果函式失敗，應該儲存錯誤的其他資訊。

傳回值

此函式可以傳回其中一個值。

傳回碼 Description
WS_E_INVALID_FORMAT
 訊息中存在多個標頭類型的實例。
E_INVALIDARG
 一或多個參數不正確。
其他錯誤
此函式可能會傳回上述未列出的其他錯誤。

備註

如果指定類型的標頭存在於訊息中，則會移除該標頭。 如果標頭不存在，則不會採取任何動作，而且函式會順利完成。

規格需求

需求 值
最低支援的用戶端 Windows 7 [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器 Windows Server 2008 R2 [傳統型應用程式 |UWP 應用程式]
目標平台 Windows
標頭 webservices.h
程式庫 WebServices.lib
Dll WebServices.dll