Funzione HttpQueryRequestQueueProperty (http.h)

Articolo
08/24/2023

La funzione HttpQueryRequestQueueProperty esegue una query su una proprietà della coda di richieste identificata dall'handle specificato.

Sintassi

HTTPAPI_LINKAGE ULONG HttpQueryRequestQueueProperty(
                  HANDLE               RequestQueueHandle,
  [in]            HTTP_SERVER_PROPERTY Property,
  [out]           PVOID                PropertyInformation,
  [in]            ULONG                PropertyInformationLength,
  [in]            ULONG                Reserved1,
  [out, optional] PULONG               ReturnLength,
  [in]            PVOID                Reserved2
);

Parametri

RequestQueueHandle

[in] Property

Membro dell'enumerazione HTTP_SERVER_PROPERTY che descrive il tipo di proprietà impostato. I possibili valori sono i seguenti:

Proprietà	Significato
HttpServer503VerbosityProperty	Esegue una query sul livello di dettaglio corrente di 503 risposte generate per la coda delle richieste.
HttpServerQueueLengthProperty	Esegue una query sul limite per il numero di richieste in sospeso nella coda delle richieste.
HttpServerStateProperty	Esegue una query sullo stato corrente della coda delle richieste. Lo stato deve essere attivo o inattivo.

[out] PropertyInformation

Puntatore al buffer che riceve le informazioni sulla proprietà.

pPropertyInformation punta a uno dei valori di informazioni sulle proprietà seguenti in base alla proprietà impostata.

Proprietà	Valore
HttpServerStateProperty	HTTP_ENABLED_STATE (membro di enumerazione)
HttpServerQueueLengthProperty	ULONG
HttpServer503VerbosityProperty	HTTP_503_RESPONSE_VERBOSITY (membro di enumerazione)

[in] PropertyInformationLength

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

[in] Reserved1

Riservato. Deve essere zero.

[out, optional] ReturnLength

Numero, in byte, restituito nel buffer pPropertyInformation se non NULL.

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 il completamento della chiamata.

[in] Reserved2

Questo parametro è riservato e deve essere NULL.

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 parametro Reserved non è zero o il parametro pReserved non è NULL. Il tipo di proprietà specificato nel parametro Property non è supportato nelle code delle richieste. Il parametro pPropertyInformation è NULL. Il parametro PropertyInformationLength è zero. L'applicazione non dispone dell'autorizzazione per aprire la coda delle richieste.
ERROR_MORE_DATA	Le dimensioni, in byte, del buffer a cui punta il parametro pPropertyInformation sono troppo piccole per ricevere le informazioni sulle proprietà. Chiamare di nuovo la funzione con un buffer pari almeno alla dimensione a cui punta pReturnLength all'uscita.
ERROR_NOT_SUPPORTED	L'handle per la coda delle richieste è un handle HTTP versione 1.0. La gestione delle proprietà è supportata solo per le code di richieste HTTP versione 2.0 e successive.

Valore

Significato

ERROR_INVALID_PARAMETER

Il parametro Reserved non è zero o il parametro pReserved non è NULL.

Il tipo di proprietà specificato nel parametro Property non è supportato nelle code delle richieste.

Il parametro pPropertyInformation è NULL.

Il parametro PropertyInformationLength è zero.

L'applicazione non dispone dell'autorizzazione per aprire la coda delle richieste.

ERROR_MORE_DATA

Le dimensioni, in byte, del buffer a cui punta il parametro pPropertyInformation sono troppo piccole per ricevere le informazioni sulle proprietà. Chiamare di nuovo la funzione con un buffer pari almeno alla dimensione a cui punta pReturnLength all'uscita.

ERROR_NOT_SUPPORTED

L'handle per la coda delle richieste è un handle HTTP versione 1.0. La gestione delle proprietà è supportata solo per le code di richieste HTTP versione 2.0 e successive.

Requisiti


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

Vedi anche

Funzioni dell'API server HTTP versione 2.0

HttpCloseRequestQueue

HttpCreateRequestQueue

HttpSetRequestQueueProperty

HttpShutdownRequestQueue

Condividi tramite