Funzione WsFlushWriter (webservices.h)

Articolo
08/27/2023

Indica al writer di richiamare il callback specificato in WS_XML_WRITER_STREAM_OUTPUT se sono stati memorizzati dati sufficienti nel buffer.

Sintassi

HRESULT WsFlushWriter(
  [in]           WS_XML_WRITER          *writer,
  [in]           ULONG                  minSize,
  [in, optional] const WS_ASYNC_CONTEXT *asyncContext,
  [in, optional] WS_ERROR               *error
);

Parametri

[in] writer

Writer da scaricare.

[in] minSize

Specifica il numero minimo di byte che devono essere memorizzati nel buffer per poter richiamare il callback . Se meno di questo numero di byte vengono memorizzati nel buffer, il callback non verrà richiamato. Questa operazione può essere usata per ridurre al minimo il numero di i/o che si verificano durante la scrittura di piccole quantità di dati.

Zero deve essere specificato per garantire che il callback venga richiamato.

[in, optional] asyncContext

Informazioni su come richiamare la funzione in modo asincrono o NULL se si richiama in modo sincrono.

[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.
WS_S_ASYNC	L'operazione asincrona è ancora in sospeso.

Commenti

Il writer memorizza tutti i dati fino a quando non viene chiamato WsFlushWriter .

Se necessario, wsFlushWriter deve essere chiamato prima che WsFreeWriter garantisca che tutti i dati vengano generati.

Specificando un WS_ASYNC_CONTEXT i dati memorizzati nel buffer verranno scritti in modo asincrono.

Questa funzione è no-op se il writer usa WS_XML_WRITER_BUFFER_OUTPUT.

Se WsWriteStartElement è stato chiamato, ma l'elemento non è stato eseguito il commit (vedere WsWriteStartElement), questo elemento non verrà scaricato.

Se questa funzione viene chiamata quando si usa WS_XML_WRITER_MTOM_ENCODING e non sono presenti elementi aperti nel writer, le parti MIME di supporto verranno generate ed emesse. Una volta eseguita questa operazione, qualsiasi API che tenta di scrivere ulteriormente nel documento XML restituirà WS_E_INVALID_OPERATION. Vedere Valori restituiti da Servizi Web Windows.

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

Share via