HttpQueryUrlGroupProperty-Funktion (http.h)

Artikel
08/24/2023

Die HttpQueryUrlGroupProperty-Funktion fragt eine Eigenschaft für die angegebene URL-Gruppe ab.

Syntax

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

Die ID der URL-Gruppe, für die die Eigenschaftseinstellung zurückgegeben wird.

[in] Property

Ein Member der HTTP_SERVER_PROPERTY-Enumeration , der den abgefragten Eigenschaftentyp beschreibt. Folgende Möglichkeiten stehen zur Auswahl:

Eigenschaft	Bedeutung
HttpServerAuthenticationProperty	Fragt die aktivierten serverseitigen Authentifizierungsschemas ab.
HttpServerTimeoutsProperty	Fragt die Timeoutlimits für die URL-Gruppe ab.
HttpServerStateProperty	Fragt den aktuellen Status der URL-Gruppe ab. Der Status kann entweder aktiviert oder deaktiviert sein.
HttpServerQosProperty	Dieser Wert wird der generischen HTTP_QOS_SETTING_INFO-Struktur zugeordnet, wobei QosType entweder auf HttpQosSettingTypeBandwidth oder HttpQosSettingTypeConnectionLimit festgelegt ist. Wenn HttpQosSettingTypeBandwidth, fragt die Bandbreiteneinschränkung für die URL-Gruppe ab. Wenn HttpQosSettingTypeConnectionLimit, fragt die maximale Anzahl ausstehender Verbindungen ab, die jederzeit für eine URL-Gruppe bereitgestellt werden.
HttpServerChannelBindProperty	Fragt die Eigenschaften des Kanalbindungstokens (CBT) ab.

[out] PropertyInformation

Ein Zeiger auf den Puffer, der die Eigenschafteninformationen empfängt.

pPropertyInformation verweist basierend auf der abgefragten Eigenschaft auf eine der folgenden Eigenschafteninformationsstrukturen.

Eigenschaft	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

Die Länge des Puffers in Bytes, auf den der pPropertyInformation-Parameter verweist.

[out, optional] ReturnLength

Die Größe 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, wird NO_ERROR zurückgegeben.

Wenn die Funktion fehlschlägt, gibt sie einen der folgenden Fehlercodes zurück.

Wert	Bedeutung
ERROR_INVALID_PARAMETER	Der im Property-Parameter angegebene Eigenschaftentyp wird für URL-Gruppen nicht unterstützt. Der UrlGroupId-Parameter identifiziert keine gültige Server-URL-Gruppe. Der Parameter pPropertyInformation ist NULL. Der PropertyInformationLength-Parameter ist null. Die Anwendung verfügt nicht über die Berechtigung zum Abfragen der URL-Gruppeneigenschaften. Nur die Anwendung, die die URL-Gruppe erstellt hat, kann die Eigenschaften abfragen.
ERROR_MORE_DATA	Die Größe des Puffers in Bytes, auf den der pPropertyInformation-Parameter verweist, ist zu klein, um die Eigenschafteninformationen zu empfangen. Rufen Sie die Funktion erneut mit einem Puffer auf, der mindestens so groß ist wie die Größe, auf die pReturnLength beim Beenden verweist.

Wert

Bedeutung

ERROR_INVALID_PARAMETER

Der im Property-Parameter angegebene Eigenschaftentyp wird für URL-Gruppen nicht unterstützt.

Der UrlGroupId-Parameter identifiziert keine gültige Server-URL-Gruppe.

Der Parameter pPropertyInformation ist NULL.

Der PropertyInformationLength-Parameter ist null.

Die Anwendung verfügt nicht über die Berechtigung zum Abfragen der URL-Gruppeneigenschaften. Nur die Anwendung, die die URL-Gruppe erstellt hat, kann die Eigenschaften abfragen.

ERROR_MORE_DATA

Die Größe des Puffers in Bytes, auf den der pPropertyInformation-Parameter verweist, ist zu klein, um die Eigenschafteninformationen zu empfangen. Rufen Sie die Funktion 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.

Anforderungen


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