Fungsi HttpQueryUrlGroupProperty (http.h)

Artikel
08/24/2023

Fungsi HttpQueryUrlGroupProperty meminta properti pada Grup URL yang ditentukan.

Sintaks

HTTPAPI_LINKAGE ULONG HttpQueryUrlGroupProperty(
  [in]            HTTP_URL_GROUP_ID    UrlGroupId,
  [in]            HTTP_SERVER_PROPERTY Property,
  [out]           PVOID                PropertyInformation,
  [in]            ULONG                PropertyInformationLength,
  [out, optional] PULONG               ReturnLength
);

Parameter

[in] UrlGroupId

ID Grup URL tempat pengaturan properti dikembalikan.

[in] Property

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

Properti	Makna
HttpServerAuthenticationProperty	Mengkueri skema autentikasi sisi server yang diaktifkan.
HttpServerTimeoutsProperty	Mengkueri batas waktu koneksi Grup URL habis.
HttpServerStateProperty	Mengkueri status Grup URL saat ini. Status dapat diaktifkan atau dinonaktifkan.
HttpServerQosProperty	Nilai ini memetakan ke struktur HTTP_QOS_SETTING_INFO generik dengan QosType diatur ke HttpQosSettingTypeBandwidth atau HttpQosSettingTypeConnectionLimit. Jika HttpQosSettingTypeBandwidth, kueri pembatasan bandwidth untuk Grup URL. Jika HttpQosSettingTypeConnectionLimit, kueri jumlah maksimum koneksi terutang yang disajikan untuk grup URL kapan saja.
HttpServerChannelBindProperty	Mengkueri properti token pengikatan saluran (CBT).

[out] PropertyInformation

Penunjuk ke buffer yang menerima informasi properti.

pPropertyInformation menunjuk ke salah satu struktur informasi properti berikut berdasarkan properti yang dikueri.

Properti	Struktur
HttpServerStateProperty	HTTP_STATE_INFO
HttpServerAuthenticationProperty	HTTP_SERVER_AUTHENTICATION_INFO
HttpServerQosProperty	HTTP_QOS_SETTING_INFO
HttpServerTimeoutsProperty	HTTP_TIMEOUT_LIMIT_INFO
HttpServerChannelBindProperty	HTTP_CHANNEL_BIND_INFO

[in] PropertyInformationLength

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

[out, optional] ReturnLength

Ukuran, dalam byte, dikembalikan dalam buffer pPropertyInformation .

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.

Nilai kembali

Jika fungsi berhasil, fungsi akan mengembalikan NO_ERROR.

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

Nilai	Makna
ERROR_INVALID_PARAMETER	Jenis properti yang ditentukan dalam parameter Properti tidak didukung untuk Grup URL. Parameter UrlGroupId tidak mengidentifikasi Grup URL server yang valid. Parameter pPropertyInformation adalah NULL. Parameter PropertyInformationLength adalah nol. Aplikasi tidak memiliki izin untuk mengkueri properti Grup URL. Hanya aplikasi yang membuat Grup URL yang dapat mengkueri properti.
ERROR_MORE_DATA	Ukuran, dalam byte, dari buffer yang ditujukkan oleh parameter pPropertyInformation terlalu kecil untuk menerima informasi properti. Panggil fungsi lagi dengan buffer setidaknya sebesar ukuran yang diacu oleh pReturnLength saat keluar.

Nilai

Makna

ERROR_INVALID_PARAMETER

Jenis properti yang ditentukan dalam parameter Properti tidak didukung untuk Grup URL.

Parameter UrlGroupId tidak mengidentifikasi Grup URL server yang valid.

Parameter pPropertyInformation adalah NULL.

Parameter PropertyInformationLength adalah nol.

Aplikasi tidak memiliki izin untuk mengkueri properti Grup URL. Hanya aplikasi yang membuat Grup URL yang dapat mengkueri properti.

ERROR_MORE_DATA

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

Keterangan

Mengkueri HttpServerLoggingProperty tidak didukung.

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