Поделиться через

Функция 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

Массив структур WS_XML_WRITER_PROPERTY , содержащий необязательные свойства для модуля записи XML.

Значение этого параметра может иметь значение NULL. В этом случае параметр propertyCount должен иметь значение 0 (ноль).

[in] propertyCount

Количество свойств в массиве свойств .

writer

При успешном выполнении указатель, получающий адрес структуры WS_XML_WRITER , представляющей созданный модуль записи XML.

Если эта структура больше не нужна, ее необходимо освободить, вызвав WsFreeWriter.

[in, optional] error

Указатель на структуру WS_ERROR , которая получает дополнительные сведения об ошибке в случае сбоя функции.

Возвращаемое значение

Если функция завершается успешно, она возвращает NO_ERROR; в противном случае возвращается код ошибки HRESULT.

Код возврата Описание
E_INVALIDARG
 Один или несколько аргументов являются недопустимыми.

Комментарии

Используйте функции WsSetOutput или WsSetOutputToBuffer , чтобы выбрать кодировку модуля записи XML и указать, куда направлять выходные данные.

WS_XML_WRITER можно использовать повторно, повторно вызвав WsSetOutput или WsSetOutputToBuffer.

Свойства, которые можно использовать для настройки модуля записи, см. в WS_XML_WRITER_PROPERTY_ID .

Модуль записи XML буферизует все данные до вызова WsFlushWriter . Это позволяет вызывающей объекту определить степень детализации для записи данных и необходимость записи этих данных асинхронно. Данные не записываются до вызова WsFlushWriter .

Если операция с WS_XML_WRITER завершается сбоем, модуль записи остается в состоянии сбоя и последующие вызовы модуля записи возвращают WS_E_OBJECT_FAULTED. (См. раздел Возвращаемые значения веб-служб Windows.) Единственные возможные вызовы функции для записи XML, если это происходит, — WsSetOutput и WsSetOutputToBuffer для возврата модуля записи XML в пригодное для использования состояние или WsFreeWriter для освобождения модуля записи XML.

Требования

Требование Значение
Минимальная версия клиента Windows 7 [классические приложения | Приложения UWP]
Минимальная версия сервера Windows Server 2008 R2 [классические приложения | Приложения UWP]
Целевая платформа Windows
Header webservices.h
Библиотека WebServices.lib
DLL WebServices.dll