Fungsi HttpQueryServerSessionProperty (http.h)

  • Artikel

Fungsi HttpQueryServerSessionProperty meminta properti server pada sesi server yang ditentukan.

Sintaks

HTTPAPI_LINKAGE ULONG HttpQueryServerSessionProperty(
  [in]            HTTP_SERVER_SESSION_ID ServerSessionId,
  [in]            HTTP_SERVER_PROPERTY   Property,
  [out]           PVOID                  PropertyInformation,
  [in]            ULONG                  PropertyInformationLength,
  [out, optional] PULONG                 ReturnLength
);

Parameter

[in] ServerSessionId

Sesi server tempat pengaturan properti dikembalikan.

[in] Property

Anggota enumerasi HTTP_SERVER_PROPERTY yang menjelaskan jenis properti yang dikueri. Ini bisa menjadi salah satu dari berikut ini.

Properti Makna
HttpServerStateProperty
 Mengkueri status sesi server saat ini.
HttpServerTimeoutsProperty
 Mengkueri batas waktu koneksi sesi server habis.
HttpServerQosProperty
 Mengkueri pembatasan bandwidth untuk sesi server. Secara default, HTTP Server API tidak membatasi bandwidth.
HttpServerAuthenticationProperty
 Mengkueri autentikasi sisi server mode kernel untuk skema autentikasi Dasar, NTLM, Negosiasi, dan Hash.
HttpServerChannelBindProperty
 Mengkueri properti token pengikatan saluran (CBT).

[out] PropertyInformation

Penunjuk ke buffer yang menerima data properti.

pPropertyInformation menunjuk ke salah satu struktur data properti berikut berdasarkan properti yang diatur.

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

[in] PropertyInformationLength

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

[out, optional] ReturnLength

Angka, 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 sesi server.

Parameter ServerSessionId tidak berisi sesi server yang valid.

Parameter pPropertyInformation adalah NULL.

Parameter PropertyInformationLength adalah nol.

Aplikasi tidak memiliki izin untuk mengkueri properti sesi server. Hanya aplikasi yang membuat sesi server yang dapat mengkueri properti.
ERROR_MORE_DATA
 Ukuran, dalam byte, dari buffer yang diacu oleh parameter pPropertyInformation terlalu kecil untuk menerima data properti. Saat keluar, panggil fungsi lagi dengan buffer setidaknya sebesar ukuran yang diacu oleh pReturnLength saat keluar.

Keterangan

Mengkueri HttpServerLoggingProperty tidak didukung.

Parameter pPropertyInformation menunjuk ke struktur konfigurasi untuk jenis properti yang dikueri. Parameter PropertyInformationLength menentukan ukuran, dalam byte, dari struktur konfigurasi. Misalnya, saat mengkueri HttpServerTimeoutsProperty , parameter pPropertyInformation harus menunjuk ke buffer yang setidaknya berukuran struktur HTTP_TIMEOUT_LIMIT_INFO .

Untuk menentukan properti HttpServerQosProperty dalam parameter pPropertyInformation , atur QosType ke HttpQosSettingTypeBandwidth di dalam struktur HTTP_QOS_SETTING_INFO , dan teruskan penunjuk ke struktur ini dalam parameter .

Persyaratan

Persyaratan Nilai
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

HttpCloseServerSession

HttpCreateServerSession

HttpQueryServerSessionProperty

HttpSetServerSessionProperty