Fungsi WsWriteEnvelopeStart (webservices.h)

Artikel
03/13/2024

Menulis awal pesan termasuk kumpulan header pesan saat ini dan bersiap untuk menulis elemen isi.

Fungsi ini dirancang untuk menulis pesan ke tujuan selain saluran. Untuk menulis pesan ke saluran, gunakan WsWriteMessageStart.

Sintaks

HRESULT WsWriteEnvelopeStart(
  [in]           WS_MESSAGE               *message,
  [in]           WS_XML_WRITER            *writer,
  [in, optional] WS_MESSAGE_DONE_CALLBACK doneCallback,
  [in, optional] void                     *doneCallbackState,
  [in, optional] WS_ERROR                 *error
);

Parameter

[in] message

Penunjuk ke objek Pesan untuk ditulis. Penunjuk harus mereferensikan objek WS_MESSAGE yang valid.

[in] writer

Penunjuk ke objek Penulis XML untuk menulis Pesan. Objek Pesan menggunakan Penulis dalam panggilan berikutnya untuk menulis pesan. Pemanggil harus menjaga penulis tetap valid hingga WsResetMessage atau WsFreeMessage dipanggil.

Parameter WS_MESSAGE_DONE_CALLBACK dapat digunakan untuk menentukan bahwa WS_XML_WRITER tidak lagi digunakan.

[in, optional] doneCallback

Fungsi panggilan balik dipanggil saat Pesan dirilis atau direset. Panggilan balik ini dapat digunakan untuk menunjukkan bahwa objek WS_XML_WRITER tidak lagi digunakan oleh pesan ini. Jika fungsi ini gagal, panggilan balik tidak dipanggil. Jika fungsi berhasil, panggilan balik hanya dipanggil satu kali.

[in, optional] doneCallbackState

Penunjuk ke status yang ditentukan pengguna yang akan diteruskan ke panggilan balik yang ditentukan. Parameter ini mungkin NULL.

[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_E_INVALID_FORMAT	Data input tidak dalam format yang diharapkan atau tidak memiliki nilai yang diharapkan.
E_OUTOFMEMORY	Kehabisan memori.
E_INVALIDARG	Satu atau beberapa argumen tidak valid.
Kesalahan Lainnya	Fungsi ini dapat mengembalikan kesalahan lain yang tidak tercantum di atas.

Keterangan

Awal pesan, termasuk kumpulan header saat ini yang ada dalam pesan, ditulis ke penulis.

Status pesan harus diatur ke WS_MESSAGE_STATE_INITIALIZED. Pada keberhasilan transisi Status pesan ke WS_MESSAGE_STATE_WRITING.
Pada transisi status kegagalan tidak terjadi.

Untuk menulis elemen isi pesan, gunakan WsWriteBody. Untuk menulis langsung ke Penulis Pesan, dapatkan Pembaca dengan WS_MESSAGE_PROPERTY_ID diatur ke properti WS_MESSAGE_PROPERTY_BODY_WRITER .

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