Функция HttpSetServiceConfiguration (http.h)

Статья
08/24/2023

Функция HttpSetServiceConfiguration создает и задает запись конфигурации для хранилища конфигурации API HTTP-сервера. Вызов завершается ошибкой, если указанная запись уже существует. Чтобы изменить заданную запись конфигурации, удалите ее, а затем повторно создайте ее с другим значением.

Синтаксис

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

Параметры

[in] ServiceHandle

Зарезервировано. Должен равняться нулю.

[in] ConfigId

Тип настраиваемой записи конфигурации. Этот параметр может быть одним из следующих значений перечисления HTTP_SERVICE_CONFIG_ID .

Значение ConfigId	Значение
HttpServiceConfigIPListenList	Задает запись в списке прослушивания IP-адресов.
HttpServiceConfigsslCertInfo	Задает указанную запись SSL-сертификата.
HttpServiceConfigUrlAclInfo	Задает запись резервирования URL-адресов.
HttpServiceConfigTimeout	Задает заданное время ожидания подключения API HTTP-сервера. Windows Vista и более поздних версий: Это значение перечисления поддерживается.
HttpServiceConfigSslSniCertInfo	Задает указанную запись сертификата SNI ssl-сервера. Windows 8 и более поздних версий: это значение перечисления поддерживается.
HttpServiceConfigSslCcsCertInfo	Задает запись SSL-сертификата, указывающую, что Http.sys должны обращаться к хранилищу централизованного хранилища сертификатов (CCS) для поиска сертификатов, если порт получает подтверждение TLS. Порт задается членом KeyDescструктуры HTTP_SERVICE_CONFIG_SSL_CCS_SET , передаваемой в параметр pConfigInformation . Windows 8 и более поздних версий: это значение перечисления поддерживается.

[in] pConfigInformation

Указатель на буфер, содержащий соответствующие данные для указания типа устанавливаемой записи.

Значение ConfigId	Значение
HttpServiceConfigIPListenList	структура HTTP_SERVICE_CONFIG_IP_LISTEN_PARAM .
HttpServiceConfigsslCertInfo	структура HTTP_SERVICE_CONFIG_SSL_SET .
HttpServiceConfigUrlAclInfo	структура HTTP_SERVICE_CONFIG_URLACL_SET .
HttpServiceConfigTimeout	структура HTTP_SERVICE_CONFIG_TIMEOUT_SET . Windows Vista и более поздних версий: Эта структура поддерживается.
HttpServiceConfigSslSniCertInfo	структура HTTP_SERVICE_CONFIG_SSL_SNI_SET . Имя узла будет "" при запросе центрального хранилища сертификатов SSL и использовании привязок с подстановочными знаками, а также имени узла для обычного SNI. Windows 8 и более поздних версий:* эта структура поддерживается.
HttpServiceConfigSslCcsCertInfo	структура HTTP_SERVICE_CONFIG_SSL_CCS_SET . Windows 8 и более поздних версий: эта структура поддерживается.

[in] ConfigInformationLength

Размер буфера pConfigInformation (в байтах).

[in] pOverlapped

Этот параметр зарезервирован и должен иметь значение NULL.

Возвращаемое значение

Если функция выполнена успешно, возвращаемое значение будет NO_ERROR.

Если функция завершается сбоем, возвращается один из следующих кодов ошибок.

Значение	Значение
ERROR_ALREADY_EXISTS	Указанная запись уже существует и должна быть удалена, чтобы ее значение было повторно задано.
ERROR_INSUFFICIENT_BUFFER	Размер буфера, указанный в параметре ConfigInformationLength , недостаточен.
ERROR_INVALID_HANDLE	Недопустимый параметр ServiceHandle .
ERROR_INVALID_PARAMETER	Один или несколько предоставленных параметров находится в непригодной для использования форме.
ERROR_NO_SUCH_LOGON_SESSION	Используемый SSL-сертификат недопустим. Это может произойти, только если используется параметр HttpServiceConfigSSLCertInfo .
Другое	Код системной ошибки, определенный в WinError.h.

Параметры конфигурации, заданные с помощью HttpSetServiceConfiguration , применяются ко всем приложениям API HTTP-сервера на компьютере и сохраняются при завершении работы API HTTP-сервера или при перезагрузке компьютера.

Требования

Требование	Значение
Минимальная версия клиента	Windows XP с пакетом обновления 2 (SP2) [только классические приложения]
Минимальная версия сервера	Windows Server 2003 [только классические приложения]
Целевая платформа	Windows
Header	http.h
Библиотека	Httpapi.lib
DLL	Httpapi.dll

См. также раздел

Функции API HTTP-сервера версии 1.0

HttpDeleteServiceConfiguration

HttpQueryServiceConfiguration

HttpUpdateServiceConfiguration

Share via