HttpQueryServerSessionProperty-Funktion (http.h)
Die HttpQueryServerSessionProperty-Funktion fragt eine Servereigenschaft für die angegebene Serversitzung ab.
Syntax
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
Die Serversitzung, für die die Eigenschaftseinstellung zurückgegeben wird.
[in] Property
Ein Member der HTTP_SERVER_PROPERTY Enumeration, das den abgefragten Eigenschaftentyp beschreibt. Dies kann einer der folgenden Sein.
[out] PropertyInformation
Ein Zeiger auf den Puffer, der die Eigenschaftendaten empfängt.
pPropertyInformation verweist auf eine der folgenden Eigenschaftendatenstrukturen basierend auf der festgelegten Eigenschaft.
| Eigenschaft | 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
Die Länge des Puffers in Bytes, auf den der pPropertyInformation-Parameter verweist.
[out, optional] ReturnLength
Die Zahl in Bytes, die im pPropertyInformation-Puffer zurückgegeben wird.
Wenn der Ausgabepuffer zu klein ist, schlägt der Aufruf mit dem Rückgabewert ERROR_MORE_DATA fehl. Der Wert, auf den pReturnLength verweist, kann verwendet werden, um die Mindestlänge des Puffers zu bestimmen, der für den erfolgreichen Aufruf erforderlich ist.
Rückgabewert
Wenn die Funktion erfolgreich ist, gibt sie NO_ERROR zurück.
Wenn die Funktion fehlschlägt, gibt sie einen der folgenden Fehlercodes zurück.
| Wert | Bedeutung |
|---|---|
|
Der im Property-Parameter angegebene Eigenschaftentyp wird für Serversitzungen nicht unterstützt.
Der ServerSessionId-Parameter enthält keine gültige Serversitzung. Der pPropertyInformation-Parameter ist NULL. Der PropertyInformationLength-Parameter ist 0. Die Anwendung verfügt nicht über die Berechtigung zum Abfragen der Serversitzungseigenschaften. Nur die Anwendung, die die Serversitzung erstellt hat, kann die Eigenschaften abfragen. |
|
Die Größe des Puffers, auf den der pPropertyInformation-Parameter verweist, ist zu klein, um die Eigenschaftendaten zu empfangen. Rufen Sie die Funktion beim Beenden erneut mit einem Puffer auf, der mindestens so groß ist wie die Größe, auf die pReturnLength beim Beenden verweist. |
Hinweise
Das Abfragen von HttpServerLoggingProperty wird nicht unterstützt.
Der pPropertyInformation-Parameter verweist auf die Konfigurationsstruktur für den abgefragten Eigenschaftentyp. Der Parameter PropertyInformationLength gibt die Größe der Konfigurationsstruktur in Bytes an. Wenn Sie beispielsweise httpServerTimeoutsProperty abfragen, muss der pPropertyInformation-Parameter auf einen Puffer zeigen, der mindestens die Größe der HTTP_TIMEOUT_LIMIT_INFO-Struktur aufweist.
Um die HttpServerQosProperty-Eigenschaft im pPropertyInformation-Parameter anzugeben, legen Sie QosType innerhalb der HTTP_QOS_SETTING_INFO-Struktur auf HttpQosSettingTypeBandwidth fest, und übergeben Sie im Parameter einen Zeiger auf diese Struktur.
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) | Windows Vista [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) | Windows Server 2008 [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | http.h |
| Bibliothek | Httpapi.lib |
| DLL | Httpapi.dll |
Weitere Informationen
FUNKTIONEN DER HTTP-Server-API, Version 2.0