Funzione WsCreateWriter (webservices.h)

Articolo
03/13/2024

crea un writer XML con le proprietà specificate.

Sintassi

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

Parametri

properties

Matrice di strutture WS_XML_WRITER_PROPERTY contenenti proprietà facoltative per il writer XML.

Il valore di questo parametro può essere NULL, nel qual caso il parametro propertyCount deve essere 0 (zero).

[in] propertyCount

Numero di proprietà nella matrice delle proprietà .

writer

In caso di esito positivo, un puntatore che riceve l'indirizzo della struttura WS_XML_WRITER che rappresenta il writer XML creato.

Quando questa struttura non è più necessaria, è necessario liberarla chiamando WsFreeWriter.

[in, optional] error

Puntatore a una struttura WS_ERROR che riceve informazioni aggiuntive sull'errore se la funzione ha esito negativo.

Valore restituito

Se la funzione ha esito positivo, restituisce NO_ERROR; in caso contrario, restituisce un codice di errore HRESULT.

Codice restituito	Descrizione
E_INVALIDARG	Uno o più argomenti non sono validi.

Commenti

Utilizzare le funzioni WsSetOutput o WsSetOutputToBuffer per scegliere la codifica del writer XML e per indicare dove indirizzare l'output.

Un WS_XML_WRITER può essere riutilizzato chiamando di nuovo WsSetOutput o WsSetOutputToBuffer .

Vedere WS_XML_WRITER_PROPERTY_ID per le proprietà che possono essere usate per configurare il writer.

Il writer XML memorizza nel buffer tutti i dati fino a quando non viene chiamato WsFlushWriter . In questo modo il chiamante può determinare la granularità di scrittura dei dati e se scrivere tali dati in modo asincrono. I dati non vengono scritti finché non viene chiamato WsFlushWriter .

Se un'operazione su un WS_XML_WRITER ha esito negativo, il writer viene lasciato in uno stato di errore e altre chiamate al writer restituiscono WS_E_OBJECT_FAULTED. Vedere Valori restituiti di Servizi Web Windows. L'unica possibile chiamata di funzione per il writer XML se si verifica è WsSetOutput e WsSetOutputToBuffer per restituire il writer XML a uno stato utilizzabile oppure WsFreeWriter per liberare il writer XML.

Requisiti

Requisito	Valore
Client minimo supportato	Windows 7 [app desktop \| App UWP]
Server minimo supportato	Windows Server 2008 R2 [app desktop \| App UWP]
Piattaforma di destinazione	Windows
Intestazione	webservices.h
Libreria	WebServices.lib
DLL	WebServices.dll

Condividi tramite