WsSetHeader 函式 (webservices.h)

  • 發行項

在訊息中加入或取代指定的標準標頭。

語法

HRESULT WsSetHeader(
  [in]           WS_MESSAGE      *message,
  [in]           WS_HEADER_TYPE  headerType,
  [in]           WS_TYPE         valueType,
  [in]           WS_WRITE_OPTION writeOption,
                 const void      *value,
  [in]           ULONG           valueSize,
  [in, optional] WS_ERROR        *error
);

參數

[in] message

要設定標頭的訊息。

訊息可以處於任何狀態，但 WS_MESSAGE_STATE_EMPTY。

[in] headerType

要序列化的標頭類型。

[in] valueType

要序列化之值的類型。 請參閱 WS_HEADER_TYPE ，以取得每種標頭類型支援的一組類型。

[in] writeOption

是否需要標頭專案，以及配置值的方式。 無法指定WS_WRITE_NILLABLE_VALUE和WS_WRITE_NILLABLE_POINTER寫入選項，因為WS_HEADER_TYPE中的標頭類型不允許在各自的標準規格中為可擷取。 如需詳細資訊 ，請參閱WS_WRITE_OPTION 。

value

要序列化的標頭值。 如需詳細資訊 ，請參閱WS_WRITE_OPTION 。

[in] valueSize

要序列化之值的大小，以位元組為單位。

[in, optional] error

指定函式失敗時應儲存其他錯誤資訊的位置。

傳回值

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

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

備註

此 API 允許設定標準標頭類型， (請參閱 WS_HEADER_TYPE) 。 針對應用程式定義的標頭類型，請使用 WsAddCustomHeader。

此 API 是設計在訊息中出現一次且以最終接收者為目標的標頭類型。 此 API 會忽略以最終接收者以外的角色/動作專案為目標的標頭。

如果指定類型的標頭 (目標為最終接收者) 已存在於訊息中，則會加以取代。

規格需求

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