Compartir a través de


Función HttpQueryUrlGroupProperty (http.h)

La función HttpQueryUrlGroupProperty consulta una propiedad en el grupo de direcciones URL especificado.

Sintaxis

HTTPAPI_LINKAGE ULONG HttpQueryUrlGroupProperty(
  [in]            HTTP_URL_GROUP_ID    UrlGroupId,
  [in]            HTTP_SERVER_PROPERTY Property,
  [out]           PVOID                PropertyInformation,
  [in]            ULONG                PropertyInformationLength,
  [out, optional] PULONG               ReturnLength
);

Parámetros

[in] UrlGroupId

Identificador del grupo de direcciones URL para el que se devuelve el valor de la propiedad.

[in] Property

Miembro de la enumeración HTTP_SERVER_PROPERTY que describe el tipo de propiedad que se consulta. Este puede ser uno de los siguientes:

Propiedad Significado
HttpServerAuthenticationProperty
Consulta los esquemas de autenticación del lado servidor habilitados.
HttpServerTimeoutsProperty
Consulta los límites de tiempo de espera de conexión del grupo de direcciones URL.
HttpServerStateProperty
Consulta el estado actual del grupo de direcciones URL. El estado se puede habilitar o deshabilitar.
HttpServerQosProperty
Este valor se asigna a la estructura de HTTP_QOS_SETTING_INFO genérica con QosType establecido en HttpQosSettingTypeBandwidth o HttpQosSettingTypeConnectionLimit. Si HttpQosSettingTypeBandwidth, consulta la limitación de ancho de banda para el grupo de direcciones URL. Si HttpQosSettingTypeConnectionLimit, consulta el número máximo de conexiones pendientes que se sirven para un grupo de direcciones URL en cualquier momento.
HttpServerChannelBindProperty
Consulta las propiedades del token de enlace de canal (CBT).

[out] PropertyInformation

Puntero al búfer que recibe la información de la propiedad.

pPropertyInformation apunta a una de las siguientes estructuras de información de propiedad en función de la propiedad que se consulta.

Propiedad Estructura
HttpServerStateProperty HTTP_STATE_INFO
HttpServerAuthenticationProperty HTTP_SERVER_AUTHENTICATION_INFO
HttpServerQosProperty HTTP_QOS_SETTING_INFO
HttpServerTimeoutsProperty HTTP_TIMEOUT_LIMIT_INFO
HttpServerChannelBindProperty HTTP_CHANNEL_BIND_INFO

[in] PropertyInformationLength

Longitud, en bytes, del búfer al que apunta el parámetro pPropertyInformation .

[out, optional] ReturnLength

Tamaño, en bytes, devuelto en el búfer pPropertyInformation .

Si el búfer de salida es demasiado pequeño, se produce un error en la llamada con un valor devuelto de ERROR_MORE_DATA. El valor al que apunta pReturnLength se puede usar para determinar la longitud mínima del búfer necesario para que la llamada se realice correctamente.

Valor devuelto

Si la función se realiza correctamente, devuelve NO_ERROR.

Si se produce un error en la función, devuelve uno de los siguientes códigos de error.

Valor Significado
ERROR_INVALID_PARAMETER
El tipo de propiedad especificado en el parámetro Property no se admite para los grupos de direcciones URL.

El parámetro UrlGroupId no identifica un grupo de direcciones URL de servidor válido.

El parámetro pPropertyInformation es NULL.

El parámetro PropertyInformationLength es cero.

La aplicación no tiene permiso para consultar las propiedades del grupo de direcciones URL. Solo la aplicación que creó el grupo de direcciones URL puede consultar las propiedades.

ERROR_MORE_DATA
El tamaño, en bytes, del búfer al que apunta el parámetro pPropertyInformation es demasiado pequeño para recibir la información de la propiedad. Vuelva a llamar a la función con un búfer al menos tan grande como el tamaño al que apunta pReturnLength al salir.

Comentarios

No se admite la consulta de HttpServerLoggingProperty .

Requisitos

   
Cliente mínimo compatible Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2008 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado http.h
Library Httpapi.lib
Archivo DLL Httpapi.dll

Consulte también

Funciones de la API de servidor HTTP versión 2.0

HttpAddUrlToUrlGroup

HttpCloseUrlGroup

HttpCreateUrlGroup

HttpRemoveUrlFromUrlGroup

HttpSetUrlGroupProperty