HttpQueryServiceConfiguration function

The HttpQueryServiceConfiguration function retrieves one or more HTTP Server API configuration records.

Syntax

C++
Copy 

ULONG HttpQueryServiceConfiguration(
  _In_        HANDLE                 ServiceHandle,
  _In_        HTTP_SERVICE_CONFIG_ID ConfigId,
  _In_opt_    PVOID                  pInputConfigInfo,
  _In_opt_    ULONG                  InputConfigInfoLength,
  _Inout_opt_ PVOID                  pOutputConfigInfo,
  _In_opt_    ULONG                  OutputConfigInfoLength,
  _Out_opt_   PULONG                 pReturnLength,
  _In_        LPOVERLAPPED           pOverlapped
);

Parameters

ServiceHandle [in]

Reserved. Must be zero.

ConfigId [in]

The configuration record query type. This parameter is one of the following values from the HTTP_SERVICE_CONFIG_ID enumeration.

ConfigId valueMeaning
HttpServiceConfigIPListenList

Queries the IP Listen List.

HttpServiceConfigSSLCertInfo

Queries the SSL store for a specific certificate record.

HttpServiceConfigUrlAclInfo

Queries URL reservation information.

HttpServiceConfigTimeout

Queries HTTP Server API wide connection timeouts.

Windows Vista and later:  This enumeration is supported.

HttpServiceConfigSslSniCertInfo

Queries the SSL Server Name Indication (SNI) store for a specific certificate record.

Windows 8 and later:  This enumeration value is supported.

HttpServiceConfigSslCcsCertInfo

Queries the SSL configuration for an SSL Centralized Certificate Store (CCS) record on the port. The port is specified by the KeyDesc member of the HTTP_SERVICE_CONFIG_SSL_CCS_QUERY structure that you pass to the pInputConfigInfo parameter.

Windows 8 and later:  This enumeration value is supported.

 

pInputConfigInfo [in, optional]

A pointer to a structure whose contents further define the query and of the type that correlates with ConfigId in the following table.

ConfigId valueMeaning
HttpServiceConfigIPListenList

No input data; set to NULL.

HttpServiceConfigSSLCertInfo

HTTP_SERVICE_CONFIG_SSL_QUERY structure.

HttpServiceConfigUrlAclInfo

HTTP_SERVICE_CONFIG_URLACL_QUERY structure.

HttpServiceConfigTimeout

HTTP_SERVICE_CONFIG_TIMEOUT_KEY structure.

Windows Vista and later:  This structure is supported.

HttpServiceConfigSslSniCertInfo

HTTP_SERVICE_CONFIG_SSL_SNI_QUERY structure.

Windows 8 and later:  This structure is supported.

HttpServiceConfigSslCcsCertInfo

HTTP_SERVICE_CONFIG_SSL_CCS_QUERY structure.

Windows 8 and later:  This structure is supported.

 

For more information, see the appropriate query structures.

InputConfigInfoLength [in, optional]

Size, in bytes, of the pInputConfigInfo buffer.

pOutputConfigInfo [in, out, optional]

A pointer to a buffer in which the query results are returned. The type of this buffer correlates with ConfigId.

ConfigId valueMeaning
HttpServiceConfigIPListenList

HTTP_SERVICE_CONFIG_IP_LISTEN_QUERY structure.

HttpServiceConfigSSLCertInfo

HTTP_SERVICE_CONFIG_SSL_SET structure.

HttpServiceConfigUrlAclInfo

HTTP_SERVICE_CONFIG_URLACL_SET structure.

HttpServiceConfigTimeout

HTTP_SERVICE_CONFIG_TIMEOUT_PARAM data type.

Windows Vista and later:  This structure is supported.

HttpServiceConfigSslSniCertInfo

HTTP_SERVICE_CONFIG_SSL_SNI_SET structure.

Windows 8 and later:  This structure is supported.

HttpServiceConfigSslCcsCertInfo

HTTP_SERVICE_CONFIG_SSL_CCS_SET structure.

Windows 8 and later:  This structure is supported.

 

OutputConfigInfoLength [in, optional]

Size, in bytes, of the pOutputConfigInfo buffer.

pReturnLength [out, optional]

A pointer to a variable that receives the number of bytes to be written in the output buffer. If the output buffer is too small, the call fails with a return value of ERROR_INSUFFICIENT_BUFFER. The value pointed to by pReturnLength can be used to determine the minimum length the buffer requires for the call to succeed.

pOverlapped [in]

Reserved for asynchronous operation and must be set to NULL.

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

ValueMeaning
ERROR_INVALID_PARAMETER

One of the parameters are invalid.

ERROR_INSUFFICIENT_BUFFER

The buffer pointed to by pOutputConfigInfo is too small to receive the output data. Call the function again with a buffer at least as large as the size pointed to by pReturnLength on exit.

ERROR_MORE_DATA

This error code is only returned when ConfigId is set to HttpServiceConfigTimeout. The buffer pointed to by pOutputConfigInfo is too small to receive the output data. Call the function again with a buffer at least as large as the size pointed to by pReturnLength on exit.

ERROR_NO_MORE_ITEMS

There are no more items to return that meet the specified criteria.

Other

A system error code defined in WinError.h.

 

Requirements

Minimum supported client

Windows Vista, Windows XP with SP2 [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header
Http.h

Library
Httpapi.lib

DLL
Httpapi.dll

See also

HTTP Server API Version 1.0 Functions
HttpSetServiceConfiguration
HttpDeleteServiceConfiguration
HttpUpdateServiceConfiguration

 

 

Show: