HttpSetUrlGroupProperty-Funktion (http.h)

Artikel
08/24/2023

Die HttpSetUrlGroupProperty-Funktion legt eine neue Eigenschaft fest oder ändert eine vorhandene Eigenschaft für die angegebene URL-Gruppe.

Syntax

HTTPAPI_LINKAGE ULONG HttpSetUrlGroupProperty(
  [in] HTTP_URL_GROUP_ID    UrlGroupId,
  [in] HTTP_SERVER_PROPERTY Property,
  [in] PVOID                PropertyInformation,
  [in] ULONG                PropertyInformationLength
);

Parameter

[in] UrlGroupId

Die ID der URL-Gruppe, für die die -Eigenschaft festgelegt ist.

[in] Property

Ein Member der HTTP_SERVER_PROPERTY Enumeration, das den geänderten oder festgelegten Eigenschaftstyp beschreibt. Folgende Möglichkeiten stehen zur Auswahl:

Eigenschaft	Bedeutung
HttpServerAuthenticationProperty	Aktiviert die serverseitige Authentifizierung für die URL-Gruppe mithilfe der Authentifizierungsschemas Basic, NTLM, Negotiate und Digest.
HttpServerExtendedAuthenticationProperty	Aktiviert die serverseitige Authentifizierung für die URL-Gruppe mithilfe des Kerberos-Authentifizierungsschemas.
HttpServerQosProperty	Dieser Wert wird der generischen HTTP_QOS_SETTING_INFO-Struktur zugeordnet, wobei QosType entweder auf HttpQosSettingTypeBandwidth oder HttpQosSettingTypeConnectionLimit festgelegt ist. Wenn HttpQosSettingTypeBandwidth, ändert oder legt die Bandbreitendrosselung für die URL-Gruppe fest. Wenn HttpQosSettingTypeConnectionLimit, ändert oder legt die maximale Anzahl ausstehender Verbindungen fest, die jederzeit für eine URL-Gruppe bereitgestellt werden.
HttpServerBindingProperty	Ändert oder legt die ZUORDNUNG der URL-Gruppe zu einer Anforderungswarteschlange fest.
HttpServerLoggingProperty	Ändert oder legt die Protokollierung für die URL-Gruppe fest.
HttpServerStateProperty	Ändert oder legt den Status der URL-Gruppe fest. Der Status kann entweder aktiviert oder deaktiviert sein.
HttpServerTimeoutsProperty	Ändert oder legt die Grenzwerte für das Verbindungstimeout für die URL-Gruppe fest.
HttpServerChannelBindProperty	Aktiviert die serverseitige Authentifizierung, die ein Kanalbindungstoken (CBT) verwendet.

[in] PropertyInformation

Ein Zeiger auf den Puffer, der die Eigenschafteninformationen enthält.

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

Eigenschaft	Struktur
HttpServerAuthenticatonProperty	HTTP_SERVER_AUTHENTICATION_INFO
HttpServerExtendedAuthenticationProperty	HTTP_SERVER_AUTHENTICATION_INFO
HttpServerQosProperty	HTTP_QOS_SETTING_INFO
HttpServerBindingProperty	HTTP_BINDING_INFO
HttpServerLoggingProperty	HTTP_LOGGING_INFO
HttpServerStateProperty	HTTP_STATE_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.

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
ERROR_INVALID_PARAMETER	Der im Property-Parameter angegebene Eigenschaftentyp wird für URL-Gruppen nicht unterstützt. Der pPropertyInformation-Parameter ist NULL. Der PropertyInformationLength-Parameter ist 0. Der UrlGroupId-Parameter enthält keine gültige Serversitzung. Die Anwendung verfügt nicht über die Berechtigung zum Festlegen der URL-Gruppeneigenschaften. Nur die Anwendung, die die URL-Gruppe erstellt hat, kann die Eigenschaften festlegen.

Wert

Bedeutung

ERROR_INVALID_PARAMETER

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

Der pPropertyInformation-Parameter ist NULL.

Der PropertyInformationLength-Parameter ist 0.

Der UrlGroupId-Parameter enthält keine gültige Serversitzung.

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

Hinweise

Nachdem die URL-Gruppe erstellt wurde, muss sie einer Anforderungswarteschlange zugeordnet sein, um Anforderungen zu empfangen. Um die URL-Gruppe einer Anforderungswarteschlange zuzuordnen, ruft die Anwendung HttpSetUrlGroupProperty mit der HttpServerBindingProperty-Eigenschaft auf. Wenn diese Eigenschaft nicht festgelegt ist, werden übereinstimmende Anforderungen für die URL-Gruppe nicht an eine Anforderungswarteschlange übermittelt, und die HTTP-Server-API generiert eine 503-Antwort.

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