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

返回代码 说明
WS_E_INVALID_FORMAT
 消息中存在同一类型的标头的多个实例。
E_OUTOFMEMORY
 内存不足，无法完成操作。
E_INVALIDARG
 一个或多个参数不正确。
其他错误
此函数可能会返回上面未列出的其他错误。

注解

WsAddCustomHeader 函数设计为以最终接收方为目标的标头类型的句柄。 忽略以另一个接收方为目标的标头。

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

要求

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