Funzione WsSetOutput (webservices.h)

Articolo
08/27/2023

Imposta i callback di codifica e output per il writer. I callback vengono usati per fornire buffer al writer e per eseguire i/o asincroni.

Sintassi

HRESULT WsSetOutput(
  [in]           WS_XML_WRITER                *writer,
  [in, optional] const WS_XML_WRITER_ENCODING *encoding,
  [in, optional] const WS_XML_WRITER_OUTPUT   *output,
                 const WS_XML_WRITER_PROPERTY *properties,
  [in]           ULONG                        propertyCount,
  [in, optional] WS_ERROR                     *error
);

Parametri

[in] writer

Writer per il quale verrà impostato l'output.

[in, optional] encoding

La codifica descrive il formato dei byte di input. Questo deve essere uno dei WS_XML_WRITER_TEXT_ENCODING, WS_XML_WRITER_BINARY_ENCODING o WS_XML_WRITER_MTOM_ENCODING.

[in, optional] output

Specifica dove il writer deve inserire i dati.

properties

Matrice di proprietà facoltative del writer. Vedere WS_XML_WRITER_PROPERTY.

[in] propertyCount

Numero di proprietà.

[in, optional] error

Specifica la posizione in cui devono essere archiviate informazioni aggiuntive sugli errori se la funzione ha esito negativo.

Valore restituito

Questa funzione può restituire uno di questi valori.

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

Commenti

Quando WsSetOutput viene usato nel writer, il writer funzionerà solo in modo inoltrato e le funzioni WsGetWriterPosition, WsSetWriterPosition e WsMoveWriterWriter non possono essere usate.

Se la codifica è NULL, WS_XML_WRITER_OUTPUT viene ignorata e il writer viene configurato in modo che qualsiasi tentativo di scrittura non riuscirà.

Se la codifica non è NULL, WS_XML_WRITER_OUTPUT deve essere non NULL .

Se WS_XML_WRITER_OUTPUT è WS_XML_WRITER_BUFFER_OUTPUT , il writer bufferrà i byte generati del documento. Usare WsGetWriterProperty con WS_XML_WRITER_PROPERTY_BUFFERS o WS_XML_WRITER_PROPERTY_BYTES per ottenere questi byte. In questa modalità WsFlushWriter non ha alcun effetto.

Se WS_XML_WRITER_OUTPUT è WS_XML_WRITER_STREAM_OUTPUT , il writer passerà i byte generati del documento al WS_WRITE_CALLBACK specificato durante le chiamate a WsFlushWriter.

Il writer verrà inizializzato per usare le proprietà specificate in WsCreateWriter. Tutte le proprietà specificate in WsSetOutput eseguiranno l'override di tali proprietà.

Vedere WsCreateWriter per i valori predefiniti delle proprietà del writer.

Requisiti


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