WsCreateReader 函数 (webservices.h)

  • 项目

创建具有指定属性的 XML 读取器 。

语法

HRESULT WsCreateReader(
                 const WS_XML_READER_PROPERTY *properties,
  [in]           ULONG                        propertyCount,
                 WS_XML_READER                **reader,
  [in, optional] WS_ERROR                     *error
);

参数

properties

包含 XML 读取器的可选属性 的WS_XML_READER_PROPERTY 结构的数组。

此参数的值可以为 NULL，在这种情况下， propertyCount 参数必须为 0 (零) 。

有关 tiy 可用于配置 XML 读取器的属性，请参阅 WS_XML_READER_PROPERTY_ID 枚举。

[in] propertyCount

属性数组中的 属性 数。

reader

成功时，一个指针，用于接收表示新 XML 读取器的 WS_XML_READER 结构的地址。

如果不再需要此结构，则必须通过调用 WsFreeReader 将其释放。

[in, optional] error

指向 WS_ERROR 结构的指针，该结构在函数失败时接收其他错误信息。

返回值

如果函数成功，则返回NO_ERROR;否则，它将返回 HRESULT 错误代码。

注解

使用 WsSetInput 或 WsSetInputToBuffer 函数选择 XML 读取器的编码并指示输入的源。

如果在传递给 WsSetInput 函数的 WS_XML_READER_INPUT 结构中指定了WS_READ_CALLBACK，则 XML 读取器仅在调用 WsFillReader 时读取其他数据。 这允许调用方确定读取数据的粒度以及是否以异步方式读取该数据。

可以通过再次调用 WsSetInput 或 WsSetInputToBuffer 来重复使用WS_XML_READER结构。

如果对 WS_XML_READER 操作的任何 API 操作失败，则 XML 读取器将保持错误状态，进一步的函数调用 将返回WS_E_OBJECT_FAULTED。 (请参阅 Windows Web Services 返回值。) 如果发生这种情况，则唯一可能的函数调用 XML 读取器是 WsSetInput 和 WsSetInputToBuffer ，用于将 XML 读取器返回到可用状态，或者 WsFreeReader 用于释放 XML 读取器对象。

要求

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