Fungsi WsGetCustomHeader (webservices.h)

Artikel
03/15/2023

Menemukan header pesan yang ditentukan aplikasi dan mendeserialisasinya.

Sintaks

HRESULT WsGetCustomHeader(
  [in]           WS_MESSAGE                   *message,
  [in]           const WS_ELEMENT_DESCRIPTION *customHeaderDescription,
  [in]           WS_REPEATING_HEADER_OPTION   repeatingOption,
  [in]           ULONG                        headerIndex,
  [in]           WS_READ_OPTION               readOption,
  [in, optional] WS_HEAP                      *heap,
                 void                         *value,
  [in]           ULONG                        valueSize,
                 ULONG                        *headerAttributes,
  [in, optional] WS_ERROR                     *error
);

Parameter

[in] message

Pesan yang berisi header .

Pesan dapat berada dalam status apa pun tetapi WS_MESSAGE_STATE_EMPTY.

[in] customHeaderDescription

WS_ELEMENT_DESCRIPTION yang menjelaskan elemen header.

[in] repeatingOption

Apakah header mungkin muncul lebih dari sekali dalam pesan.

Jika WS_REPEATING_HEADER digunakan, maka indeks header menunjukkan header mana dengan headerName yang ditentukan untuk dikembalikan.

Jika WS_SINGLETON_HEADER digunakan, headerIndex harus nol.

[in] headerIndex

Indeks header berbasis nol dalam kumpulan header dengan headerName yang ditentukan.

[in] readOption

Apakah nilai diperlukan, dan cara mengalokasikan nilai. Lihat WS_READ_OPTION untuk informasi selengkapnya.

[in, optional] heap

Timbunan untuk menyimpan data header yang dideserialisasi. Jika ini NULL, maka timbunan pesan akan digunakan sebagaimana diperlukan oleh WS_READ_OPTION.

value

Interpretasi parameter ini tergantung pada WS_READ_OPTION.

[in] valueSize

Interpretasi parameter ini tergantung pada WS_READ_OPTION.

headerAttributes

Mengembalikan WS_HEADER_ATTRIBUTES untuk header ini. Penunjuk mungkin NULL, dalam hal ini tidak ada atribut yang dikembalikan.

[in, optional] error

Menentukan di mana informasi kesalahan tambahan harus disimpan jika fungsi gagal.

Nilai kembali

Fungsi ini dapat mengembalikan salah satu nilai ini.

Menampilkan kode	Deskripsi
WS_E_INVALID_FORMAT	Header tidak ada, dan diperlukan. WS_SINGLETON_HEADER ditentukan, dan ada beberapa instans jenis header yang ada dalam pesan. Data input tidak dalam format yang diharapkan.
WS_E_QUOTA_EXCEEDED	Kuota ukuran timbunan terlampaui.
E_OUTOFMEMORY	Tidak tersedia cukup memori untuk mendeserialisasi header.
E_INVALIDARG	Satu atau beberapa parameter salah.
Kesalahan Lainnya	Fungsi ini dapat mengembalikan kesalahan lain yang tidak tercantum di atas.

Keterangan

API ini beroperasi pada header yang ditargetkan pada penerima utama.
Header yang ditargetkan dengan peran/aktor selain penerima utama diabaikan oleh API ini.

Persyaratan


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