WsReadMessageStart 函数 (webservices.h)

  • 项目

从通道中读取下一条消息的标头，并准备读取正文元素。

语法

HRESULT WsReadMessageStart(
  [in]           WS_CHANNEL             *channel,
  [in]           WS_MESSAGE             *message,
  [in, optional] const WS_ASYNC_CONTEXT *asyncContext,
  [in, optional] WS_ERROR               *error
);

参数

[in] channel

要从中接收的通道。

[in] message

要接收的消息。

[in, optional] asyncContext

有关如何异步调用函数的信息;如果同步调用，则为 NULL 。

[in, optional] error

指定在函数失败时应存储其他错误信息的位置。

返回值

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

返回代码 说明
S_OK
 已成功收到消息的开始。
WS_S_END
 频道上没有其他消息可用。
WS_S_ASYNC
 异步操作仍处于挂起状态。
WS_E_OPERATION_ABORTED
 操作已中止。
WS_E_INVALID_OPERATION
 由于 对象的当前状态，不允许此操作。
WS_E_ENDPOINT_NOT_FOUND
 远程终结点不存在或找不到。
WS_E_ENDPOINT_ACCESS_DENIED
 远程终结点拒绝访问。
WS_E_ENDPOINT_DISCONNECTED
 与远程终结点的连接已终止。
WS_E_ENDPOINT_FAILURE
 远程终结点无法处理请求。
WS_E_ENDPOINT_NOT_AVAILABLE
 远程终结点当前未在此位置使用。
WS_E_ENDPOINT_TOO_BUSY
 由于重载，远程终结点无法处理请求。
WS_E_ENDPOINT_UNREACHABLE
 无法访问远程终结点。
WS_E_INVALID_ENDPOINT_URL
 终结点地址 URL 无效。
WS_E_INVALID_FORMAT
 输入数据的格式不是预期的，或者没有预期的值。
WS_E_OPERATION_TIMED_OUT
 该操作未在分配的时间内完成。
WS_E_PROXY_ACCESS_DENIED
 HTTP 代理服务器拒绝访问。
WS_E_PROXY_FAILURE
 HTTP 代理服务器无法处理请求。
WS_E_QUOTA_EXCEEDED
 超出配额。
WS_E_SECURITY_VERIFICATION_FAILURE
 对于收到的数据，安全验证未成功。
WS_E_SECURITY_SYSTEM_FAILURE
 Windows Web Services 框架中的安全操作失败。
WS_E_SECURITY_TOKEN_EXPIRED
 服务器拒绝了安全令牌，因为它已过期。
WS_E_PROXY_REQUIRES_BASIC_AUTH
 HTTP 代理服务器需要 HTTP 身份验证方案“basic”。
WS_E_PROXY_REQUIRES_DIGEST_AUTH
 HTTP 代理服务器需要 HTTP 身份验证方案“digest”。
WS_E_PROXY_REQUIRES_NEGOTIATE_AUTH
 HTTP 代理服务器需要 HTTP 身份验证方案“协商”。
WS_E_PROXY_REQUIRES_NTLM_AUTH
 HTTP 代理服务器需要 HTTP 身份验证方案“NTLM”。
WS_E_SERVER_REQUIRES_BASIC_AUTH
 远程终结点需要 HTTP 身份验证方案“基本”。
WS_E_SERVER_REQUIRES_DIGEST_AUTH
 远程终结点需要 HTTP 身份验证方案“digest”。
WS_E_SERVER_REQUIRES_NEGOTIATE_AUTH
 远程终结点需要 HTTP 身份验证方案“协商”。
WS_E_SERVER_REQUIRES_NTLM_AUTH
 远程终结点需要 HTTP 身份验证方案“NTLM”。
CERT_E_EXPIRED
 根据当前系统时钟或签名文件中的时间戳进行验证时，所需的证书不在有效期内。
CERT_E_CN_NO_MATCH
 证书 CN 名称与传递的值不匹配。
CERT_E_UNTRUSTEDROOT
 已处理的证书链，但在信任提供程序不信任的根证书中终止。
CERT_E_WRONG_USAGE
 该证书对于请求的用法无效。
CRYPT_E_REVOCATION_OFFLINE
 吊销功能无法检查吊销，因为吊销服务器已脱机。
E_OUTOFMEMORY
 内存不足。
E_INVALIDARG
 一个或多个参数无效。
其他错误
此函数可能会返回上面未列出的其他错误。

注解

这会从通道读取下一条消息的开头，包括消息的标头。

此函数类似于 WsReadEnvelopeStart ，但与通道一起使用。

成功后，标头将存储在消息中，并且可以以随机访问方式访问 (例如，使用 WsGetHeader) 。

消息必须处于 WS_MESSAGE_STATE_EMPTY 状态。 成功后，消息将转换为 WS_MESSAGE_STATE_READING 状态。

若要反序列化消息正文的元素，请使用 WsReadBody。 若要直接从消息的 XML 读取器进行读取，请先使用 WS_MESSAGE_PROPERTY_BODY_READER 属性获取读取器。

如果通道输入 (WS_STREAMED_INPUT_TRANSFER_MODE) 流式传输，则必须调用 WsFillBody 以接收正文的下一部分，然后才能实际读取它。

要求

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