Fonction HttpSetServiceConfiguration (http.h)

Article
03/02/2024

La fonction HttpSetServiceConfiguration crée et définit un enregistrement de configuration pour le magasin de configuration de l’API du serveur HTTP. L’appel échoue si l’enregistrement spécifié existe déjà. Pour modifier un enregistrement de configuration donné, supprimez-le, puis recréez-le avec une autre valeur.

Syntaxe

HTTPAPI_LINKAGE ULONG HttpSetServiceConfiguration(
  [in] HANDLE                 ServiceHandle,
  [in] HTTP_SERVICE_CONFIG_ID ConfigId,
  [in] PVOID                  pConfigInformation,
  [in] ULONG                  ConfigInformationLength,
  [in] LPOVERLAPPED           pOverlapped
);

Paramètres

[in] ServiceHandle

Réservé. Doit être zéro.

[in] ConfigId

Type d’enregistrement de configuration à définir. Ce paramètre peut être l’une des valeurs suivantes de l’énumération HTTP_SERVICE_CONFIG_ID .

Valeur configId	Signification
HttpServiceConfigIPListenList	Définit un enregistrement dans la liste d’écoute IP.
HttpServiceConfigSSLCertInfo	Définit un enregistrement de certificat SSL spécifié.
HttpServiceConfigUrlAclInfo	Définit un enregistrement de réservation d’URL.
HttpServiceConfigTimeout	Définit un délai d’expiration de connexion au niveau de l’API serveur HTTP spécifié. Windows Vista et versions ultérieures : Cette valeur d’énumération est prise en charge.
HttpServiceConfigSslSniCertInfo	Définit un enregistrement de certificat SNI (SSL Server Name Indication) spécifié. Windows 8 et versions ultérieures : cette valeur d’énumération est prise en charge.
HttpServiceConfigSslCcsCertInfo	Définit l’enregistrement de certificat SSL qui spécifie que Http.sys devez consulter le magasin de certificats centralisé (CCS) pour rechercher les certificats si le port reçoit une négociation TLS (Transport Layer Security). Le port est spécifié par le membre KeyDesc de la structure HTTP_SERVICE_CONFIG_SSL_CCS_SET que vous passez au paramètre pConfigInformation . Windows 8 et versions ultérieures : cette valeur d’énumération est prise en charge.

[in] pConfigInformation

Pointeur vers une mémoire tampon qui contient les données appropriées pour spécifier le type d’enregistrement à définir.

Valeur configId	Signification
HttpServiceConfigIPListenList	HTTP_SERVICE_CONFIG_IP_LISTEN_PARAM structure.
HttpServiceConfigSSLCertInfo	HTTP_SERVICE_CONFIG_SSL_SET structure.
HttpServiceConfigUrlAclInfo	HTTP_SERVICE_CONFIG_URLACL_SET structure.
HttpServiceConfigTimeout	HTTP_SERVICE_CONFIG_TIMEOUT_SET structure. Windows Vista et versions ultérieures : Cette structure est prise en charge.
HttpServiceConfigSslSniCertInfo	HTTP_SERVICE_CONFIG_SSL_SNI_SET structure. Le nom d’hôte est « * » lorsque le magasin de certificats central SSL est interrogé et que des liaisons de caractères génériques sont utilisées, ainsi qu’un nom d’hôte pour le SNI standard. Windows 8 et versions ultérieures : cette structure est prise en charge.
HttpServiceConfigSslCcsCertInfo	HTTP_SERVICE_CONFIG_SSL_CCS_SET structure. Windows 8 et versions ultérieures : cette structure est prise en charge.

[in] ConfigInformationLength

Taille, en octets, de la mémoire tampon pConfigInformation .

[in] pOverlapped

Ce paramètre est réservé et doit avoir la valeur NULL.

Valeur retournée

Si la fonction réussit, la valeur de retour est NO_ERROR.

Si la fonction échoue, la valeur de retour est l’un des codes d’erreur suivants.

Valeur	Signification
ERROR_ALREADY_EXISTS	L’enregistrement spécifié existe déjà et doit être supprimé pour que sa valeur soit à nouveau définie.
ERROR_INSUFFICIENT_BUFFER	La taille de mémoire tampon spécifiée dans le paramètre ConfigInformationLength est insuffisante.
ERROR_INVALID_HANDLE	Le paramètre ServiceHandle n’est pas valide.
ERROR_INVALID_PARAMETER	Un ou plusieurs des paramètres fournis sont sous une forme inutilisable.
ERROR_NO_SUCH_LOGON_SESSION	Le certificat SSL utilisé n’est pas valide. Cela ne peut se produire que si le paramètre HttpServiceConfigSSLCertInfo est utilisé.
Autres	Code d’erreur système défini dans WinError.h.

Remarques

Les paramètres de configuration définis avec HttpSetServiceConfiguration sont appliqués à toutes les applications d’API serveur HTTP sur l’ordinateur et persistent lorsque l’API du serveur HTTP s’arrête ou lorsque l’ordinateur est redémarré.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP avec SP2 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	http.h
Bibliothèque	Httpapi.lib
DLL	Httpapi.dll

Voir aussi

Fonctions API de serveur HTTP version 1.0

HttpDeleteServiceConfiguration

HttpQueryServiceConfiguration

HttpUpdateServiceConfiguration

Partager via