Fungsi WsFlushBody (webservices.h)

Artikel
03/13/2024

Membersihkan semua data isi pesan terakumulasi yang telah ditulis.

Ketika pesan menggunakan WsWriteBody atau XML Writer, data diakumulasikan dalam buffer. WsFlushBody kemudian melakukan I/O yang sebenarnya.

WsFlushBody biasanya digunakan saat I/O saluran diatur ke WS_STREAMED_OUTPUT_TRANSFER_MODE, atau saat menggunakan set Penulis XML untuk menggunakan WS_XML_WRITER_STREAM_OUTPUT.

Sintaks

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

Parameter

[in] message

Penunjuk ke struktur WS_MESSAGE yang berisi data isi pesan yang terakumulasi.

[in] minSize

Menentukan jumlah minimum byte yang harus ada dalam pesan agar fungsi dapat melakukan flush data.

Catatan Jika pesan berisi kurang dari minSize WSFlushBody berakhir tanpa melakukan flush I/O. Nilai yang lebih besar akan memastikan bahwa tidak ada I/O yang akan dilakukan sampai nilai yang lebih besar telah terakumulasi. Ini berguna untuk memastikan bahwa potongan yang lebih besar digunakan saat melakukan I/O. Dan dengan asumsi bahwa setidaknya ada satu byte data akumulasi nilai 0 dalam minSize menjamin bahwa data tersebut akan dihapus.

[in, optional] asyncContext

Penunjuk ke struktur data WS_ASYNC_CONTEXT dengan informasi tentang memanggil fungsi secara asinkron. Nilai NULL menunjukkan permintaan untuk operasi sinkron.

[in, optional] error

Penunjuk ke objek WS_ERROR tempat informasi tambahan tentang kesalahan harus disimpan jika fungsi gagal.

Mengembalikan nilai

Fungsi ini dapat mengembalikan salah satu nilai ini.

Menampilkan kode	Deskripsi
WS_S_ASYNC	Operasi asinkron masih tertunda.
WS_E_INVALID_FORMAT	Data input tidak dalam format yang diharapkan atau tidak memiliki nilai yang diharapkan.
E_INVALIDARG	Satu atau beberapa argumen tidak valid.
E_OUTOFMEMORY	Kehabisan memori.
Kesalahan Lainnya	Fungsi ini dapat mengembalikan kesalahan lain yang tidak tercantum di atas.

Keterangan

Fungsi ini adalah "no-op" ketika WS_STREAMED_OUTPUT_TRANSFER_MODE tidak diatur, atau saat menggunakan XML Writer dengan set WS_XML_WRITER_BUFFER_OUTPUT .

Fungsi ini adalah pintasan untuk memanggil WsFlushWriter untuk Penulis XML yang digunakan untuk menulis pesan. Memanggil WsFlushWriter secara langsung setara dengan memanggil fungsi ini.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 7 [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows Server 2008 R2 [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	webservices.h
Pustaka	WebServices.lib
DLL	WebServices.dll

Bagikan melalui