HttpSetServerSessionProperty-Funktion (http.h)

Artikel
08/24/2023

Die HttpSetServerSessionProperty-Funktion legt eine neue Serversitzungseigenschaft fest oder ändert eine vorhandene Eigenschaft für die angegebene Serversitzung.

Syntax

HTTPAPI_LINKAGE ULONG HttpSetServerSessionProperty(
  [in] HTTP_SERVER_SESSION_ID ServerSessionId,
  [in] HTTP_SERVER_PROPERTY   Property,
  [in] PVOID                  PropertyInformation,
  [in] ULONG                  PropertyInformationLength
);

Parameter

[in] ServerSessionId

Die Serversitzung, für die die -Eigenschaft festgelegt ist.

[in] Property

Ein Element der HTTP_SERVER_PROPERTY-Enumeration , das den festgelegten Eigenschaftentyp beschreibt. Dies kann einer der folgenden Sein.

Eigenschaft	Bedeutung
HttpServerStateProperty	Ändert oder legt den Zustand der Serversitzung fest. Der Zustand kann entweder aktiviert oder deaktiviert sein. der Standardzustand ist aktiviert.
HttpServerTimeoutsProperty	Ändert oder legt die Timeoutlimits für Serversitzungen fest.
HttpServerQosProperty	Ändert oder legt die Bandbreitendrosselung für die Serversitzung fest. Standardmäßig begrenzt die HTTP-Server-API die Bandbreite nicht. Hinweis Dieser Wert wird der generischen HTTP_QOS_SETTING_INFO-Struktur zugeordnet, wobei QosType auf HttpQosSettingTypeBandwidth festgelegt ist.
HttpServerLoggingProperty	Aktiviert oder deaktiviert die Protokollierung für die Serversitzung. Diese Eigenschaft legt nur die zentralisierte W3C- und die zentralisierte binäre Protokollierung fest. Standardmäßig ist die Protokollierung nicht aktiviert.
HttpServerAuthenticationProperty	Aktiviert die serverseitige Kernelmodusauthentifizierung für die Authentifizierungsschemas Basic, NTLM, Negotiate und Digest.
HttpServerExtendedAuthenticationProperty	Aktiviert die serverseitige Kernelmodusauthentifizierung für das Kerberos-Authentifizierungsschema.
HttpServerChannelBindProperty	Aktiviert die serverseitige Authentifizierung, die ein Kanalbindungstoken (CBT) verwendet.

[in] PropertyInformation

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

pPropertyInformation verweist auf eine Eigenschaftendatenstruktur, die in der folgenden Tabelle basierend auf der festgelegten Eigenschaft aufgeführt ist.

Eigenschaft	Struktur
HttpServerStateProperty	HTTP_STATE_INFO
HttpServerLoggingProperty	HTTP_LOGGING_INFO
HttpServerQosProperty	HTTP_QOS_SETTING_INFO
HttpServerTimeoutsProperty	HTTP_TIMEOUT_LIMIT_INFO
HttpServerAuthenticationProperty	HTTP_SERVER_AUTHENTICATION_INFO
HttpServerExtendedAuthenticationProperty	HTTP_SERVER_AUTHENTICATION_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 Serversitzungen nicht unterstützt. Der pPropertyInformation-Parameter ist NULL. Der PropertyInformationLength-Parameter ist 0. Der ServerSessionId-Parameter enthält keine gültige Serversitzung. Die Anwendung verfügt nicht über die Berechtigung zum Festlegen der Serversitzungseigenschaften. Nur die Anwendung, die die Serversitzung erstellt hat, kann die Eigenschaften festlegen.

Wert

Bedeutung

ERROR_INVALID_PARAMETER

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

Der pPropertyInformation-Parameter ist NULL.

Der PropertyInformationLength-Parameter ist 0.

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

Die Anwendung verfügt nicht über die Berechtigung zum Festlegen der Serversitzungseigenschaften. Nur die Anwendung, die die Serversitzung erstellt hat, kann die Eigenschaften festlegen.

Hinweise

Serversitzungen sind Konfigurationscontainer der obersten Ebene für Konfigurationsdaten, die für alle unter ihnen erstellten URL-Gruppen gelten. Die Serversitzung wird mit HttpCreateServerSession erstellt.

Der pPropertyInformation-Parameter verweist auf die Konfigurationsstruktur für den festgelegten Eigenschaftentyp. Der Parameter PropertyInformationLength gibt die Größe der Konfigurationsstruktur in Bytes an. Wenn Sie beispielsweise httpServerTimeoutsProperty festlegen, muss der pPropertyInformation-Parameter auf einen Puffer zeigen, der mindestens der Größe der HTTP_TIMEOUT_LIMIT_INFO-Struktur entspricht.

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

HttpCloseServerSession

HttpCreateServerSession

HttpQueryServerSessionProperty

HttpSetServerSessionProperty