HttpQueryRequestQueueProperty-Funktion (http.h)

  • Artikel

Die HttpQueryRequestQueueProperty-Funktion fragt eine Eigenschaft der Anforderungswarteschlange ab, die durch das angegebene Handle identifiziert wird.

Syntax

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

Parameter

RequestQueueHandle

[in] Property

Ein Element der HTTP_SERVER_PROPERTY-Enumeration , das den festgelegten Eigenschaftentyp beschreibt. Folgende Möglichkeiten stehen zur Auswahl:

Eigenschaft Bedeutung
HttpServer503VerbosityProperty
 Fragt den aktuellen Ausführlichkeitsgrad von 503 Antworten ab, die für die Anforderungswarteschlange generiert wurden.
HttpServerQueueLengthProperty
 Fragt den Grenzwert für die Anzahl der ausstehenden Anforderungen in der Anforderungswarteschlange ab.
HttpServerStateProperty
 Fragt den aktuellen Zustand der Anforderungswarteschlange ab. Der Status muss entweder aktiv oder inaktiv sein.

[out] PropertyInformation

Ein Zeiger auf den Puffer, der die Eigenschafteninformationen empfängt.

pPropertyInformation verweist basierend auf der festgelegten Eigenschaft auf einen der folgenden Eigenschaftsinformationswerte.

Eigenschaft Wert
HttpServerStateProperty HTTP_ENABLED_STATE (Enumerationsmember)
HttpServerQueueLengthProperty ULONG
HttpServer503VerbosityProperty HTTP_503_RESPONSE_VERBOSITY (Enumerationsmember)

[in] PropertyInformationLength

Die Länge des Puffers in Bytes, auf den der pPropertyInformation-Parameter verweist.

[in] Reserved1

Reserviert. Muss Null sein.

[out, optional] ReturnLength

Die Zahl in Bytes, die im pPropertyInformation-Puffer zurückgegeben wird, wenn nicht NULL.

Wenn der Ausgabepuffer zu klein ist, schlägt der Aufruf mit dem Rückgabewert ERROR_MORE_DATA fehl. Der Wert, auf den pReturnLength verweist, kann verwendet werden, um die Mindestlänge des Puffers zu bestimmen, der für den erfolgreichen Aufruf erforderlich ist.

[in] Reserved2

Dieser Parameter ist reserviert und muss NULL sein.

Rückgabewert

Wenn die Funktion erfolgreich ist, gibt sie NO_ERROR zurück.

Wenn die Funktion fehlschlägt, gibt sie einen der folgenden Fehlercodes zurück.

Wert Bedeutung
ERROR_INVALID_PARAMETER
 Der Reserved-Parameter ist nicht 0 oder der pReserved-Parameter ist nicht NULL.

Der im Property-Parameter angegebene Eigenschaftentyp wird in Anforderungswarteschlangen nicht unterstützt.

Der pPropertyInformation-Parameter ist NULL.

Der PropertyInformationLength-Parameter ist 0.

Die Anwendung verfügt nicht über die Berechtigung zum Öffnen der Anforderungswarteschlange.
ERROR_MORE_DATA
 Die Größe des Puffers, auf den der pPropertyInformation-Parameter verweist, ist zu klein, um die Eigenschafteninformationen zu empfangen. Rufen Sie die Funktion erneut mit einem Puffer auf, der mindestens so groß ist wie die Größe, auf die pReturnLength beim Beenden verweist.
ERROR_NOT_SUPPORTED
 Das Handle für die Anforderungswarteschlange ist ein HTTP-Handle der Version 1.0. Die Eigenschaftenverwaltung wird nur für Anforderungswarteschlangen mit HTTP-Version 2.0 und höher unterstützt.

Anforderungen

   
Unterstützte Mindestversion (Client) Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2008 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile http.h
Bibliothek Httpapi.lib
DLL Httpapi.dll

Weitere Informationen

FUNKTIONEN DER HTTP-Server-API, Version 2.0

HttpCloseRequestQueue

HttpCreateRequestQueue

HttpSetRequestQueueProperty

HttpShutdownRequestQueue