Fungsi WsFillBody (webservices.h)

Artikel
03/03/2024

Memastikan bahwa ada cukup banyak byte yang tersedia dalam pesan untuk dibaca. Terserah aplikasi untuk menentukan jumlah byte yang cukup untuk memuat konstruksi XML berikutnya untuk dibaca.

Catatan Fungsi ini dipanggil sebelum menggunakan WsReadBody atau Pembaca XMLdari pesan untuk membaca isi pesan.

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

Sintaks

HRESULT WsFillBody(
  [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 ditujukan untuk "mengisi".

[in] minSize

Jumlah minimum byte yang seharusnya di-buffer oleh pesan. Jika jumlah byte saat ini di-buffer sama dengan atau lebih besar dari nilai minSize , fungsi tidak melakukan apa pun.

Catatan Nilai minSize mewakili ukuran bentuk XML yang dikodekan yang diharapkan. Ini dapat bervariasi menurut pengodean dan juga bagaimana XML aktual disusun. Penggunaan umum fungsi ini adalah memilih jumlah byte terikat atas yang diharapkan untuk pengodean atau struktur XML untuk memastikan bahwa data yang diharapkan dibaca.

[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
S_OK	Awal pesan berhasil diterima.
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 Lain	Fungsi ini dapat mengembalikan kesalahan lain yang tidak tercantum di atas.

Keterangan

Fungsi ini biasanya digunakan saat menulis isi pesan dengan mode streaming yang diatur ke WS_STREAMED_OUTPUT_TRANSFER_MODE, atau saat menggunakan Pembaca XML dalam mode streaming.

Fungsi ini adalah "no-op" saat menulis isi pesan dan WS_STREAMED_OUTPUT_TRANSFER_MODE tidak diatur, atau dengan mode Pembaca XML diatur ke WS_XML_READER_BUFFER_INPUT.

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