Fungsi HttpQueryRequestQueueProperty (http.h)

Artikel
08/24/2023

Fungsi HttpQueryRequestQueueProperty meminta properti antrean permintaan yang diidentifikasi oleh handel yang ditentukan.

Sintaks

HTTPAPI_LINKAGE ULONG HttpQueryRequestQueueProperty(
                  HANDLE               RequestQueueHandle,
  [in]            HTTP_SERVER_PROPERTY Property,
  [out]           PVOID                PropertyInformation,
  [in]            ULONG                PropertyInformationLength,
  [in]            ULONG                Reserved1,
  [out, optional] PULONG               ReturnLength,
  [in]            PVOID                Reserved2
);

Parameter

RequestQueueHandle

[in] Property

Anggota enumerasi HTTP_SERVER_PROPERTY yang menjelaskan jenis properti yang ditetapkan. Bisa jadi salah satu dari yang berikut:

Properti	Makna
HttpServer503VerbosityProperty	Mengkueri tingkat verbositas saat ini dari 503 respons yang dihasilkan untuk antrean permintaan.
HttpServerQueueLengthProperty	Mengkueri batas jumlah permintaan yang belum terutang dalam antrean permintaan.
HttpServerStateProperty	Mengkueri status antrean permintaan saat ini. Status harus aktif atau tidak aktif.

[out] PropertyInformation

Penunjuk ke buffer yang menerima informasi properti.

pPropertyInformation menunjuk ke salah satu nilai informasi properti berikut berdasarkan properti yang diatur.

Properti	Nilai
HttpServerStateProperty	HTTP_ENABLED_STATE (anggota enumerasi)
HttpServerQueueLengthProperty	ULONG
HttpServer503VerbosityProperty	HTTP_503_RESPONSE_VERBOSITY (anggota enumerasi)

[in] PropertyInformationLength

Panjang, dalam byte, dari buffer yang diacu oleh parameter pPropertyInformation .

[in] Reserved1

Dicadangkan. Harus nol.

[out, optional] ReturnLength

Angka, dalam byte, dikembalikan dalam buffer pPropertyInformation jika bukan NULL.

Jika buffer output terlalu kecil, panggilan gagal dengan nilai pengembalian ERROR_MORE_DATA. Nilai yang ditunjukkan oleh pReturnLength dapat digunakan untuk menentukan panjang minimum buffer yang diperlukan agar panggilan berhasil.

[in] Reserved2

Parameter ini dicadangkan dan harus NULL.

Menampilkan nilai

Jika fungsi berhasil, fungsi akan mengembalikan NO_ERROR.

Jika fungsi gagal, fungsi akan mengembalikan salah satu kode kesalahan berikut.

Nilai	Makna
ERROR_INVALID_PARAMETER	Parameter Yang Dicadangkan bukan nol atau parameter pReserved bukan NULL. Jenis properti yang ditentukan dalam parameter Properti tidak didukung pada antrean permintaan. Parameter pPropertyInformation adalah NULL. Parameter PropertyInformationLength adalah nol. Aplikasi tidak memiliki izin untuk membuka antrean permintaan.
ERROR_MORE_DATA	Ukuran, dalam byte, dari buffer yang diacu oleh parameter pPropertyInformation terlalu kecil untuk menerima informasi properti. Panggil fungsi lagi dengan buffer setidaknya sebesar ukuran yang diacu oleh pReturnLength saat keluar.
ERROR_NOT_SUPPORTED	Handel ke antrean permintaan adalah handel HTTP versi 1.0. Manajemen properti hanya didukung untuk antrean permintaan HTTP versi 2.0 dan yang lebih baru.

Nilai

Makna

ERROR_INVALID_PARAMETER

Parameter Yang Dicadangkan bukan nol atau parameter pReserved bukan NULL.

Jenis properti yang ditentukan dalam parameter Properti tidak didukung pada antrean permintaan.

Parameter pPropertyInformation adalah NULL.

Parameter PropertyInformationLength adalah nol.

Aplikasi tidak memiliki izin untuk membuka antrean permintaan.

ERROR_MORE_DATA

Ukuran, dalam byte, dari buffer yang diacu oleh parameter pPropertyInformation terlalu kecil untuk menerima informasi properti. Panggil fungsi lagi dengan buffer setidaknya sebesar ukuran yang diacu oleh pReturnLength saat keluar.

ERROR_NOT_SUPPORTED

Handel ke antrean permintaan adalah handel HTTP versi 1.0. Manajemen properti hanya didukung untuk antrean permintaan HTTP versi 2.0 dan yang lebih baru.

Persyaratan


Klien minimum yang didukung	Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2008 [hanya aplikasi desktop]
Target Platform	Windows
Header	http.h
Pustaka	Httpapi.lib
DLL	Httpapi.dll

Lihat juga

Fungsi HTTP Server API Versi 2.0

HttpCloseRequestQueue

HttpCreateRequestQueue

HttpSetRequestQueueProperty

HttpShutdownRequestQueue

Bagikan melalui