WsAddMappedHeader 函式 (webservices.h)

  • 發行項

將指定的對應標頭新增至 訊息。

語法

HRESULT WsAddMappedHeader(
  [in]           WS_MESSAGE          *message,
  [in]           const WS_XML_STRING *headerName,
  [in]           WS_TYPE             valueType,
  [in]           WS_WRITE_OPTION     writeOption,
  [in]           const void          *value,
  [in]           ULONG               valueSize,
  [in, optional] WS_ERROR            *error
);

參數

[in] message

WS_MESSAGE 結構的指標，表示要加入對應標頭的訊息。

訊息可以處於任何狀態 ，但WS_MESSAGE_STATE_EMPTY ( 請參閱 WS_MESSAGE_STATE 列舉。

[in] headerName

包含標頭名稱 的WS_XML_STRING 指標。

[in] valueType

要還原串行化的標頭值類型。 如需可能的類型和對應的標頭，請參閱 WS_HEADER_TYPE

[in] writeOption

是否需要標頭，以及配置值的方式。 如需詳細資訊，請參閱 WS_WRITE_OPTION 列舉。

[in] value

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

[in] valueSize

要串行化之值的大小，以位元組為單位。

[in, optional] error

如果函式失敗，WS_ERROR結構的指標，該結構會收到其他錯誤資訊。

傳回值

如果函式成功，它會傳回NO_ERROR;否則會傳回 HRESULT 錯誤碼。

傳回碼 Description
E_OUTOFMEMORY
 記憶體不足，無法完成作業。
E_INVALIDARG
 一或多個參數不正確。
其他錯誤
此函式可能會傳回上面未列出的其他錯誤。

備註

郵件可能包含不屬於郵件信封一部分的其他傳輸特定資訊。 此傳輸特定資訊可以透過程序設計方式公開為訊息的標頭。 WsAddMappedHeader 函式可用來新增這類標頭，以對應至某些傳輸特定位置。

當您使用 HTTP 通道時，必須先指定必要的對應，才能呼叫此函式以新增標頭。 如需詳細資訊，請參閱 WS_HTTP_MESSAGE_MAPPING。

如果您要取代標頭，請先呼叫 WsRemoveMappedHeader 函 式，以在呼叫 WsAddMappedHeader 之前移除標頭的現有實例。

規格需求

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