Share via

WsRemoveHeader 函数 (webservices.h)

  • 项目

从消息中删除标准 WS_HEADER_TYPE 对象。

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

对于应用程序定义的标头类型，请使用 WsRemoveCustomHeader 函数。

语法

HRESULT WsRemoveHeader(
  [in]           WS_MESSAGE     *message,
  [in]           WS_HEADER_TYPE headerType,
  [in, optional] WS_ERROR       *error
);

参数

[in] message

指向 Message 对象的指针 ，其中包含要删除的标头。 消息可以处于除 WS_MESSAGE_STATE_EMPTY之外的任何状态。

[in] headerType

指示要删除的标头的类型。

[in, optional] error

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

返回值

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

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

注解

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

要求

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