Función WsCreateReader (webservices.h)

Crea un lector XML con las propiedades especificadas.

Sintaxis

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

Parámetros

properties

Matriz de estructuras de WS_XML_READER_PROPERTY que contienen propiedades opcionales para el lector XML.

El valor de este parámetro puede ser NULL, en cuyo caso el parámetro propertyCount debe ser 0 (cero).

Para conocer las propiedades que se pueden usar para configurar el lector XML, vea la enumeración WS_XML_READER_PROPERTY_ID .

[in] propertyCount

Número de propiedades de la matriz de propiedades .

reader

Si se ejecuta correctamente, un puntero que recibe la dirección de la estructura de WS_XML_READER que representa el nuevo lector XML.

Cuando ya no necesite esta estructura, debe liberarla llamando a WsFreeReader.

[in, optional] error

Puntero a una estructura de WS_ERROR que recibe información de error adicional si se produce un error en la función.

Valor devuelto

Si la función se realiza correctamente, devuelve NO_ERROR; de lo contrario, devuelve un código de error HRESULT.

Comentarios

Use las funciones WsSetInput o WsSetInputToBuffer para elegir la codificación para el lector XML e indicar el origen de la entrada.

Si WS_READ_CALLBACK se especifica en la estructura de WS_XML_READER_INPUT que se pasa a la función WsSetInput , el lector XML lee datos adicionales solo cuando se llama a WsFillReader . Esto permite al autor de la llamada determinar en qué granularidad leer datos y si se van a leer esos datos de forma asincrónica.

Una estructura de WS_XML_READER se puede reutilizar llamando de nuevo a WsSetInput o WsSetInputToBuffer .

Si se produce un error en cualquier operación de API que funciona en un WS_XML_READER se produce un error, el lector XML se deja en un estado defectuoso y las llamadas de función adicionales devuelven WS_E_OBJECT_FAULTED. (Consulte Valores devueltos de servicios web de Windows). La única posible llamada de función para el lector XML si esto ocurre es WsSetInput y WsSetInputToBuffer para devolver el lector XML a un estado utilizable, o WsFreeReader para liberar el objeto de lector XML.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 7 [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible	Windows Server 2008 R2 [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	webservices.h
Library	WebServices.lib
Archivo DLL	WebServices.dll