WsRemoveCustomHeader 函数 (webservices.h)

  • 项目

从消息中删除自定义标头。

此函数旨在处理在消息中出现一次且以最终接收方为目标的标头类型。 将忽略具有最终接收方以外的其他角色的标头。

语法

HRESULT WsRemoveCustomHeader(
  [in]           WS_MESSAGE          *message,
  [in]           const WS_XML_STRING *headerName,
  [in]           const WS_XML_STRING *headerNs,
  [in, optional] WS_ERROR            *error
);

参数

[in] message

指向 Message 对象的指针 ，其中包含要删除的标头。

消息可以处于除 WS_MESSAGE_STATE_EMPTY之外的任何状态。

[in] headerName

指向引用要删除的标头元素的“本地名称”的 WS_XML_STRING 对象的指针。

[in] headerNs

指向 WS_XML_STRING 对象的指针，该对象引用要删除的标头元素的命名空间。

[in, optional] error

指向 WS_ERROR 对象的指针，如果函数失败，应存储有关错误的其他信息。

返回值

此函数可以返回其中一个值。

返回代码 说明
WS_E_INVALID_FORMAT
 消息中存在标头类型的多个实例。
E_OUTOFMEMORY
 没有足够的内存可用于序列化标头。
E_INVALIDARG
 一个或多个参数不正确。
其他错误
此函数可能会返回上面未列出的其他错误。

注解

如果消息中存在给定类型的标头，则会将其删除。 如果标头不存在，则函数不执行任何操作并成功完成。

要求

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