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

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

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

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

Свойства, которые tiy может использовать для настройки средства чтения XML, см. в перечислении WS_XML_READER_PROPERTY_ID .

[in] propertyCount

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

reader

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

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

[in, optional] error

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

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

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

Комментарии

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

Если в структуре WS_XML_READER_INPUT, передаваемой функции WsSetInput, указано WS_READ_CALLBACK, средство чтения XML считывает дополнительные данные только при вызове WsFillReader. Это позволяет вызывающей объекту определить степень детализации для чтения данных и следует ли считывать эти данные асинхронно.

Структуру WS_XML_READER можно использовать повторно, повторно вызвав WsSetInput или WsSetInputToBuffer .

Если какая-либо операция API, которая работает с WS_XML_READER завершается сбоем, средство чтения XML остается в неисправном состоянии, а последующие вызовы функций возвращают WS_E_OBJECT_FAULTED. (См. раздел Возвращаемые значения веб-служб Windows.) Единственные возможные вызовы функций для средства чтения XML, если это происходит, — WsSetInput и WsSetInputToBuffer для возврата средства чтения XML в пригодное состояние или WsFreeReader для освобождения объекта средства чтения XML.

Требования

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