WsFlushBody-Funktion (webservices.h)

Artikel
03/03/2024

Löscht alle kumulierten Nachrichtentextdaten, die geschrieben wurden.

Wenn die Nachricht WsWriteBody oder XML Writer verwendet, werden die Daten in einem Puffer gesammelt. WsFlushBody führt anschließend die tatsächlichen E/A-Vorgänge aus.

WsFlushBody wird in der Regel verwendet, wenn Kanal-E/A auf WS_STREAMED_OUTPUT_TRANSFER_MODE festgelegt ist, oder wenn ein XML Writer-Satz verwendet wird, um WS_XML_WRITER_STREAM_OUTPUT zu verwenden.

Syntax

HRESULT WsFlushBody(
  [in]           WS_MESSAGE             *message,
  [in]           ULONG                  minSize,
  [in, optional] const WS_ASYNC_CONTEXT *asyncContext,
  [in, optional] WS_ERROR               *error
);

Parameter

[in] message

Ein Zeiger auf die WS_MESSAGE-Struktur , die die akkumulierten Nachrichtentextdaten enthält.

[in] minSize

Gibt die Mindestanzahl von Bytes an, die in der Nachricht vorhanden sein müssen, damit die Funktion die Datenleerung ausführen kann.

Hinweis Wenn die Nachricht weniger als minSize enthält, wird WSFlushBody beendet, ohne die E/A-Leerung durchzuführen. Ein größerer Wert stellt sicher, dass keine E/A-Vorgänge ausgeführt werden, bis der größere Wert akkumuliert wurde. Dies ist nützlich, um sicherzustellen, dass größere Blöcke beim E/A-Vorgang verwendet werden. Vorausgesetzt, es gibt mindestens ein Byte akkumulierter Daten mit dem Wert 0 in minSize , wird sichergestellt, dass sie geleert werden.

[in, optional] asyncContext

Ein Zeiger auf eine WS_ASYNC_CONTEXT Datenstruktur mit Informationen zum asynchronen Aufrufen der Funktion. Ein NULL-Wert gibt eine Anforderung für einen synchronen Vorgang an.

[in, optional] error

Ein Zeiger auf ein WS_ERROR-Objekt , in dem zusätzliche Informationen zum Fehler gespeichert werden sollen, wenn die Funktion fehlschlägt.

Rückgabewert

Diese Funktion kann einen dieser Werte zurückgeben.

Rückgabecode	Beschreibung
WS_S_ASYNC	Der asynchrone Vorgang steht noch aus.
WS_E_INVALID_FORMAT	Die Eingabedaten waren nicht im erwarteten Format oder hatten nicht den erwarteten Wert.
E_INVALIDARG	Mindestens ein Argument ist ungültig.
E_OUTOFMEMORY	Der Arbeitsspeicher ist nicht mehr vorhanden.
Andere Fehler	Diese Funktion gibt möglicherweise andere Fehler zurück, die oben nicht aufgeführt sind.

Hinweise

Diese Funktion ist "no-op", wenn WS_STREAMED_OUTPUT_TRANSFER_MODE nicht festgelegt ist oder wenn ein XML Writer mit WS_XML_WRITER_BUFFER_OUTPUT festgelegt ist.

Diese Funktion ist eine Verknüpfung zum Aufrufen von WsFlushWriter für den XML Writer, der zum Schreiben der Nachricht verwendet wird. Das direkte Aufrufen von WsFlushWriter entspricht dem Aufrufen dieser Funktion.

Anforderungen

Anforderung	Wert
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

Freigeben über