Funzione HttpQueryUrlGroupProperty (http.h)

Articolo
08/24/2023

La funzione HttpQueryUrlGroupProperty esegue una query su una proprietà nel gruppo DI URL specificato.

Sintassi

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

Parametri

[in] UrlGroupId

ID del gruppo DI URL 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. I possibili valori sono i seguenti:

Proprietà	Significato
HttpServerAuthenticationProperty	Esegue query sugli schemi di autenticazione lato server abilitati.
HttpServerTimeoutsProperty	Esegue query sui limiti di timeout di connessione del gruppo di URL.
HttpServerStateProperty	Esegue query sullo stato corrente del gruppo DI URL. Lo stato può essere abilitato o disabilitato.
HttpServerQosProperty	Questo valore esegue il mapping alla struttura di HTTP_QOS_SETTING_INFO generica con QosType impostata su HttpQosSettingTypeBandwidth o HttpQosSettingTypeConnectionLimit. Se HttpQosSettingTypeBandwidth esegue una query sulla limitazione della larghezza di banda per il gruppo di URL. Se HttpQosSettingTypeConnectionLimit esegue query sul numero massimo di connessioni in sospeso servite per un gruppo DI URL in qualsiasi momento.
HttpServerChannelBindProperty	Esegue una query sulle proprietà CBT (Channel Binding Token).

[out] PropertyInformation

Puntatore al buffer che riceve le informazioni sulla proprietà.

pPropertyInformation punta a una delle strutture di informazioni sulle proprietà seguenti in base alla proprietà che viene eseguita una query.

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

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

[out, optional] ReturnLength

Le dimensioni, in byte, restituite 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 i gruppi di URL. Il parametro UrlGroupId non identifica un gruppo DI URL del server valido. Il parametro pPropertyInformation è NULL. Il parametro PropertyInformationLength è zero. L'applicazione non dispone dell'autorizzazione per eseguire query sulle proprietà del gruppo di URL. Solo l'applicazione che ha creato il gruppo DI URL 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 le informazioni sulla proprietà. Chiamare 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 i gruppi di URL.

Il parametro UrlGroupId non identifica un gruppo DI URL del server valido.

Il parametro pPropertyInformation è NULL.

Il parametro PropertyInformationLength è zero.

L'applicazione non dispone dell'autorizzazione per eseguire query sulle proprietà del gruppo di URL. Solo l'applicazione che ha creato il gruppo DI URL 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 le informazioni sulla proprietà. Chiamare 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.

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