WsRemoveCustomHeader 函式 (webservices.h)

  • 發行項

從訊息中移除自訂標頭。

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

語法

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
 一或多個參數不正確。
其他錯誤
此函式可能會傳回上面未列出的其他錯誤。

備註

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

規格需求

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