Funzione HttpQueryServerSessionProperty (http.h)

Articolo
02/26/2024

La funzione HttpQueryServerSessionProperty esegue una query su una proprietà server nella sessione del server specificata.

Sintassi

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
);

Parametri

[in] ServerSessionId

Sessione del server per cui viene restituita l'impostazione della proprietà.

[in] Property

Membro dell'enumerazione HTTP_SERVER_PROPERTY che descrive il tipo di proprietà sottoposto a query. Questo può essere uno dei seguenti.

Proprietà	Significato
HttpServerStateProperty	Esegue query sullo stato corrente della sessione del server.
HttpServerTimeoutsProperty	Esegue query sui limiti di timeout della connessione della sessione del server.
HttpServerQosProperty	Esegue una query sulla limitazione della larghezza di banda per la sessione del server. Per impostazione predefinita, l'API server HTTP non limita la larghezza di banda.
HttpServerAuthenticationProperty	Esegue query sull'autenticazione lato server in modalità kernel per gli schemi di autenticazione basic, NTLM, Negozia e Digest.
HttpServerChannelBindProperty	Esegue una query sulle proprietà CBT (Channel Binding Token).

[out] PropertyInformation

Puntatore al buffer che riceve i dati delle proprietà.

pPropertyInformation punta a una delle strutture di dati delle proprietà seguenti in base alla proprietà impostata.

Proprietà	Struttura
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

Lunghezza, in byte, del buffer a cui fa riferimento il parametro pPropertyInformation .

[out, optional] ReturnLength

Numero, in byte, restituito nel buffer pPropertyInformation .

Se il buffer di output è troppo piccolo, la chiamata ha esito negativo con un valore restituito di ERROR_MORE_DATA. Il valore a cui punta pReturnLength può essere usato per determinare la lunghezza minima del buffer necessaria per la chiamata.

Valore restituito

Se la funzione ha esito positivo, restituisce NO_ERROR

Se la funzione ha esito negativo, restituisce uno dei codici di errore seguenti.

Valore	Significato
ERROR_INVALID_PARAMETER	Il tipo di proprietà specificato nel parametro Property non è supportato per le sessioni del server. Il parametro ServerSessionId non contiene una sessione server valida. Il parametro pPropertyInformation è NULL. Il parametro PropertyInformationLength è zero. L'applicazione non dispone dell'autorizzazione per eseguire query sulle proprietà della sessione del server. Solo l'applicazione che ha creato la sessione del server può eseguire query sulle proprietà.
ERROR_MORE_DATA	Le dimensioni, in byte, del buffer a cui punta il parametro pPropertyInformation sono troppo piccole per ricevere i dati delle proprietà. In uscita chiama di nuovo la funzione con un buffer almeno di grandi dimensioni a cui punta pReturnLength all'uscita.

Valore

Significato

ERROR_INVALID_PARAMETER

Il tipo di proprietà specificato nel parametro Property non è supportato per le sessioni del server.

Il parametro ServerSessionId non contiene una sessione server valida.

Il parametro pPropertyInformation è NULL.

Il parametro PropertyInformationLength è zero.

L'applicazione non dispone dell'autorizzazione per eseguire query sulle proprietà della sessione del server. Solo l'applicazione che ha creato la sessione del server può eseguire query sulle proprietà.

ERROR_MORE_DATA

Le dimensioni, in byte, del buffer a cui punta il parametro pPropertyInformation sono troppo piccole per ricevere i dati delle proprietà. In uscita chiama di nuovo la funzione con un buffer almeno di grandi dimensioni a cui punta pReturnLength all'uscita.

Commenti

L'esecuzione di query su HttpServerLoggingProperty non è supportata.

Il parametro pPropertyInformation punta alla struttura di configurazione per il tipo di proprietà sottoposto a query. Il parametro PropertyInformationLength specifica le dimensioni, in byte, della struttura di configurazione. Ad esempio, quando si esegue una query sul parametro httpServerTimeoutsProperty il parametro pPropertyInformation deve puntare a un buffer che è almeno la dimensione della struttura HTTP_TIMEOUT_LIMIT_INFO .

Per specificare la proprietà HttpServerQosProperty nel parametro pPropertyInformation, impostare QosType su HttpQosSettingTypeBandwidth all'interno della struttura HTTP_QOS_SETTING_INFO e passare un puntatore a questa struttura nel parametro.

Requisiti

Requisito	Valore
Client minimo supportato	Windows Vista [solo app desktop]
Server minimo supportato	Windows Server 2008 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	http.h
Libreria	Httpapi.lib
DLL	Httpapi.dll