WsCreateWriter 函数 (webservices.h)
创建具有指定属性的 XML 编写器 。
语法
HRESULT WsCreateWriter(
const WS_XML_WRITER_PROPERTY *properties,
[in] ULONG propertyCount,
WS_XML_WRITER **writer,
[in, optional] WS_ERROR *error
);
参数
properties
包含 XML 编写器的可选属性 的WS_XML_WRITER_PROPERTY 结构的数组。
此参数的值可以为 NULL,在这种情况下, propertyCount 参数必须为 0 (零) 。
[in] propertyCount
properties 数组中的 属性 数。
writer
成功时,一个指针,用于接收表示所创建的 XML 编写器的 WS_XML_WRITER 结构的地址。
如果不再需要此结构,则必须通过调用 WsFreeWriter 来释放它。
[in, optional] error
指向 WS_ERROR 结构的指针,该结构在函数失败时接收其他错误信息。
返回值
如果函数成功,则返回NO_ERROR;否则,它将返回 HRESULT 错误代码。
返回代码 | 说明 |
---|---|
|
一个或多个参数无效。 |
注解
使用 WsSetOutput 或 WsSetOutputToBuffer 函数选择 XML 编写器的编码并指示将输出定向到何处。
可以通过再次调用 WsSetOutput 或 WsSetOutputToBuffer 来重复使用WS_XML_WRITER。
有关可用于配置编写器的属性,请参阅 WS_XML_WRITER_PROPERTY_ID 。
XML 编写器会缓冲所有数据,直到调用 WsFlushWriter 。 这样,调用方就可以确定以何种粒度写入数据,以及是否异步写入数据。 在调用 WsFlushWriter 之前,不会写入数据。
如果 对WS_XML_WRITER 的操作失败,编写器将保持错误状态,对编写器的进一步调用将 返回WS_E_OBJECT_FAULTED。 (请参阅 Windows Web Services 返回值。) 如果发生这种情况,唯一可能的函数调用 XML 编写器是 WsSetOutput 和 WsSetOutputToBuffer 将 XML 编写器返回到可用状态,或 WsFreeWriter 释放 XML 编写器。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows 7 [桌面应用 |UWP 应用] |
最低受支持的服务器 | Windows Server 2008 R2 [桌面应用 |UWP 应用] |
目标平台 | Windows |
标头 | webservices.h |
Library | WebServices.lib |
DLL | WebServices.dll |