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

Статья
01/11/2024

Функция HttpQueryServiceConfiguration извлекает одну или несколько записей конфигурации API HTTP-сервера.

Синтаксис

HTTPAPI_LINKAGE ULONG HttpQueryServiceConfiguration(
  [in]                HANDLE                 ServiceHandle,
  [in]                HTTP_SERVICE_CONFIG_ID ConfigId,
  [in, optional]      PVOID                  pInput,
  [in, optional]      ULONG                  InputLength,
  [in, out, optional] PVOID                  pOutput,
  [in, optional]      ULONG                  OutputLength,
  [out, optional]     PULONG                 pReturnLength,
  [in]                LPOVERLAPPED           pOverlapped
);

Параметры

[in] ServiceHandle

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

[in] ConfigId

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

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

[in, optional] pInput

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

Значение ConfigId	Значение
HttpServiceConfigIPListenList	Нет входных данных; задайте значение NULL.
HttpServiceConfigsslCertInfo	HTTP_SERVICE_CONFIG_SSL_QUERY структура.
HttpServiceConfigUrlAclInfo	HTTP_SERVICE_CONFIG_URLACL_QUERY структура.
HttpServiceConfigTimeout	структура HTTP_SERVICE_CONFIG_TIMEOUT_KEY . Windows Vista и более поздних версий: Эта структура поддерживается.
HttpServiceConfigSslSniCertInfo	структура HTTP_SERVICE_CONFIG_SSL_SNI_QUERY . Windows 8 и более поздних версий: эта структура поддерживается.
HttpServiceConfigSslCcsCertInfo	структура HTTP_SERVICE_CONFIG_SSL_CCS_QUERY . Windows 8 и более поздних версий: эта структура поддерживается.

Дополнительные сведения см. в разделе о соответствующих структурах запросов.

[in, optional] InputLength

Размер буфера pInputConfigInfo в байтах.

[in, out, optional] pOutput

Указатель на буфер, в котором возвращаются результаты запроса. Тип этого буфера коррелирует с ConfigId.

Значение ConfigId	Значение
HttpServiceConfigIPListenList	HTTP_SERVICE_CONFIG_IP_LISTEN_QUERY структура.
HttpServiceConfigsslCertInfo	структура HTTP_SERVICE_CONFIG_SSL_SET .
HttpServiceConfigUrlAclInfo	структура HTTP_SERVICE_CONFIG_URLACL_SET .
HttpServiceConfigTimeout	HTTP_SERVICE_CONFIG_TIMEOUT_PARAM тип данных. Windows Vista и более поздних версий: Эта структура поддерживается.
HttpServiceConfigSslSniCertInfo	структура HTTP_SERVICE_CONFIG_SSL_SNI_SET . Windows 8 и более поздних версий: эта структура поддерживается.
HttpServiceConfigSslCcsCertInfo	структура HTTP_SERVICE_CONFIG_SSL_CCS_SET . Windows 8 и более поздних версий: эта структура поддерживается.

[in, optional] OutputLength

Размер буфера pOutputConfigInfo в байтах.

[out, optional] pReturnLength

Указатель на переменную, получающую количество байтов, записываемых в выходной буфер. Если выходной буфер слишком мал, вызов завершается ошибкой с возвращаемым значением ERROR_INSUFFICIENT_BUFFER. Значение, на которое указывает pReturnLength , можно использовать для определения минимальной длины буфера, необходимой для успешного вызова.

[in] pOverlapped

Зарезервировано для асинхронной операции и должно иметь значение NULL.

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

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

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

Значение	Значение
ERROR_INVALID_PARAMETER	Один из параметров недопустим.
ERROR_INSUFFICIENT_BUFFER	Буфер, на который указывает pOutputConfigInfo , слишком мал для получения выходных данных. Снова вызовите функцию с буфером, размером не ниже размера, на который указывает pReturnLength при выходе.
ERROR_MORE_DATA	Буфер, на который указывает pOutputConfigInfo , слишком мал для получения выходных данных. Снова вызовите функцию с буфером, размером не ниже размера, на который указывает pReturnLength при выходе.
ERROR_NO_MORE_ITEMS	Больше нет возвращаемых элементов, соответствующих указанным условиям.
Другое	Код системной ошибки, определенный в WinError.h.

Требования


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

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

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

HttpDeleteServiceConfiguration

HttpSetServiceConfiguration

HttpUpdateServiceConfiguration

Поделиться через