Función WsCreateWriter (webservices.h)

crea un objeto de escritura XML con las propiedades especificadas.

Sintaxis

HRESULT WsCreateWriter(
                 const WS_XML_WRITER_PROPERTY *properties,
  [in]           ULONG                        propertyCount,
                 WS_XML_WRITER                **writer,
  [in, optional] WS_ERROR                     *error
);

Parámetros

properties

Matriz de estructuras de WS_XML_WRITER_PROPERTY que contienen propiedades opcionales para el sistema de escritura XML.

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

[in] propertyCount

Número de propiedades de la matriz de propiedades .

writer

Si se ejecuta correctamente, un puntero que recibe la dirección de la estructura WS_XML_WRITER que representa el sistema de escritura XML creado.

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

[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 WsSetOutput o WsSetOutputToBuffer para elegir la codificación del escritor XML e indicar dónde dirigir la salida.

Se puede reutilizar un WS_XML_WRITER llamando de nuevo a WsSetOutput o WsSetOutputToBuffer .

Consulte WS_XML_WRITER_PROPERTY_ID para conocer las propiedades que se pueden usar para configurar el sistema de escritura.

El escritor XML almacena en búfer todos los datos hasta que se llama a WsFlushWriter . Esto permite al autor de la llamada determinar en qué granularidad escribir datos y en si se escriben esos datos de forma asincrónica. Los datos no se escriben hasta que se llama a WsFlushWriter .

Si se produce un error en una operación en un WS_XML_WRITER , el escritor se deja en estado de error y se devuelven más llamadas al escritor WS_E_OBJECT_FAULTED. (Vea Valores devueltos de servicios web de Windows). Las únicas llamadas de función posibles para el escritor XML si esto ocurre son WsSetOutput y WsSetOutputToBuffer para devolver el escritor XML a un estado utilizable, o WsFreeWriter para liberar el escritor XML.

Requisitos