Función HttpQueryServerSessionProperty (http.h)
La función HttpQueryServerSessionProperty consulta una propiedad de servidor en la sesión de servidor especificada.
HTTPAPI_LINKAGE ULONG HttpQueryServerSessionProperty(
[in] HTTP_SERVER_SESSION_ID ServerSessionId,
[in] HTTP_SERVER_PROPERTY Property,
[out] PVOID PropertyInformation,
[in] ULONG PropertyInformationLength,
[out, optional] PULONG ReturnLength
);
[in] ServerSessionId
Sesión de servidor para la 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. Esto puede ser uno de los siguientes.
[out] PropertyInformation
Puntero al búfer que recibe los datos de propiedad.
pPropertyInformation apunta a una de las siguientes estructuras de datos de propiedad en función de la propiedad establecida.
Propiedad | Estructura |
---|---|
HttpServerStateProperty | HTTP_STATE_INFO |
HttpServerQosProperty | HTTP_QOS_SETTING_INFO |
HttpServerTimeoutsProperty | HTTP_TIMEOUT_LIMIT_INFO |
HttpServerAuthenticationProperty | HTTP_SERVER_AUTHENTICATION_INFO |
HttpServerChannelBindProperty | HTTP_CHANNEL_BIND_INFO |
[in] PropertyInformationLength
Longitud, en bytes, del búfer al que apunta el parámetro pPropertyInformation .
[out, optional] ReturnLength
Número, 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.
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 |
---|---|
|
El tipo de propiedad especificado en el parámetro Property no se admite para las sesiones de servidor.
El parámetro ServerSessionId no contiene una sesión de servidor válida. El parámetro pPropertyInformation es NULL. El parámetro PropertyInformationLength es cero. La aplicación no tiene permiso para consultar las propiedades de la sesión del servidor. Solo la aplicación que creó la sesión del servidor puede consultar las propiedades. |
|
El tamaño, en bytes, del búfer al que apunta el parámetro pPropertyInformation es demasiado pequeño para recibir los datos de propiedad. Al salir, llame a la función de nuevo con un búfer al menos tan grande como el tamaño al que apunta pReturnLength al salir. |
No se admite la consulta de HttpServerLoggingProperty .
El parámetro pPropertyInformation apunta a la estructura de configuración del tipo de propiedad que se consulta. El parámetro PropertyInformationLength especifica el tamaño, en bytes, de la estructura de configuración. Por ejemplo, al consultar httpServerTimeoutsProperty , el parámetro pPropertyInformation debe apuntar a un búfer que sea al menos el tamaño de la estructura de HTTP_TIMEOUT_LIMIT_INFO .
Para especificar la propiedad HttpServerQosProperty en el parámetro pPropertyInformation , establezca QosType en HttpQosSettingTypeBandwidth dentro de la estructura HTTP_QOS_SETTING_INFO y pase un puntero a esta estructura en el parámetro .
Requisito | Value |
---|---|
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 |
Funciones de la API de servidor HTTP versión 2.0