WsFlushWriter-Funktion (webservices.h)

Artikel
08/27/2023

Weist den Writer an, den in WS_XML_WRITER_STREAM_OUTPUT angegebenen Rückruf aufzurufen, wenn genügend Daten gepuffert wurden.

Syntax

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

Parameter

[in] writer

Der zu leerende Writer.

[in] minSize

Gibt die Mindestanzahl von Bytes an, die gepuffert werden müssen, damit der Rückruf aufgerufen wird. Wenn weniger als diese Anzahl von Bytes gepuffert werden, wird der Rückruf nicht aufgerufen. Dies kann verwendet werden, um die Anzahl der E/A-Vorgänge zu minimieren, die beim Schreiben kleiner Datenmengen auftreten.

Null sollte angegeben werden, um sicherzustellen, dass der Rückruf aufgerufen wird.

[in, optional] asyncContext

Informationen zum asynchronen Aufrufen der Funktion oder NULL beim synchronen Aufrufen.

[in, optional] error

Gibt an, wo zusätzliche Fehlerinformationen gespeichert werden sollen, wenn die Funktion fehlschlägt.

Rückgabewert

Diese Funktion kann einen dieser Werte zurückgeben.

Rückgabecode	Beschreibung
E_INVALIDARG	Mindestens ein Argument ist ungültig.
WS_S_ASYNC	Der asynchrone Vorgang steht noch aus.

Hinweise

Der Writer puffert alle Daten, bis WsFlushWriter aufgerufen wird.

Bei Bedarf sollte der WsFlushWriter vor WsFreeWriter aufgerufen werden, um sicherzustellen, dass alle Daten ausgegeben werden.

Durch Angabe eines WS_ASYNC_CONTEXT werden die gepufferten Daten asynchron geschrieben.

Diese Funktion ist nicht aktiviert, wenn der Writer WS_XML_WRITER_BUFFER_OUTPUT verwendet.

Wenn WsWriteStartElement aufgerufen wurde, das Element aber nicht committet wurde (siehe WsWriteStartElement), wird dieses Element nicht geleert.

Wenn diese Funktion aufgerufen wird, wenn WS_XML_WRITER_MTOM_ENCODING verwendet wird und keine geöffneten Elemente im Writer vorhanden sind, werden die unterstützenden MIME-Teile generiert und ausgegeben. Sobald dies geschieht, gibt jede API, die versucht, weiter in das XML-Dokument zu schreiben , WS_E_INVALID_OPERATION zurück. (Siehe Rückgabewerte für Windows-Webdienste.)

Anforderungen


Unterstützte Mindestversion (Client)	Windows 7 [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 R2 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	webservices.h
Bibliothek	WebServices.lib
DLL	WebServices.dll