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 错误代码。

返回代码 说明
E_OUTOFMEMORY
 内存不足，无法完成操作。
E_INVALIDARG
 一个或多个参数不正确。
其他错误
此函数可能会返回上面未列出的其他错误。

注解

邮件可能包含不属于邮件信封的一部分的其他特定于传输的信息。 此特定于传输的信息可以编程方式作为消息的标头公开。 WsAddMappedHeader 函数用于添加此类标头，该标头将映射到某些特定于传输的位置。

使用 HTTP 通道时，必须先指定所需的映射，然后才能调用此函数来添加标头。 有关详细信息，请参阅 WS_HTTP_MESSAGE_MAPPING。

如果要替换标头，请在调用 WsAddMappedHeader 之前调用 WsRemoveMappedHeader 函数以删除标头的现有实例。

要求

要求 值
最低受支持的客户端 Windows 7 [桌面应用 |UWP 应用]
最低受支持的服务器 Windows Server 2008 R2 [桌面应用 |UWP 应用]
目标平台 Windows
标头 webservices.h
Library WebServices.lib
DLL WebServices.dll