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 錯誤碼。

傳回碼 Description
WS_E_INVALID_FORMAT
 訊息中存在相同標頭類型的多個實例。
E_OUTOFMEMORY
 記憶體不足，無法完成作業。
E_INVALIDARG
 一或多個參數不正確。
其他錯誤
此函式可能會傳回上述未列出的其他錯誤。

備註

WsAddCustomHeader 函式是設計以最終接收者為目標的標頭類型。 忽略以另一個接收者為目標的標頭。

如果您要取代標頭，請先呼叫 WsRemoveCustomHeader 函式，先移除標頭的現有實例，再呼叫 WsAddCustomHeader。

規格需求

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