共用方式為

HTTPQueryRequestQueueProperty 函式 (HTTP.h)

  • 發行項

HttpQueryRequestQueueProperty 函式會查詢指定控制碼所識別之要求佇列的屬性。

語法

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

參數

RequestQueueHandle

[in] Property

描述所設定屬性類型的 HTTP_SERVER_PROPERTY 列舉成員。 這可以是下列項目之一：

屬性 意義
HttpServer503VerbosityProperty
 查詢針對要求佇列產生的目前 503 回應詳細資訊層級。
HttpServerQueueLengthProperty
 查詢要求佇列中未處理要求數目的限制。
HttpServerStateProperty
 查詢要求佇列的目前狀態。 狀態必須是作用中或非作用中。

[out] PropertyInformation

接收屬性資訊的緩衝區指標。

pPropertyInformation 會根據所設定的屬性，指向下列其中一個屬性值。

屬性 值
HttpServerStateProperty HTTP_ENABLED_STATE (列舉成員)
HttpServerQueueLengthProperty ULONG
HttpServer503VerbosityProperty HTTP_503_RESPONSE_VERBOSITY (列舉成員)

[in] PropertyInformationLength

pPropertyInformation參數所指向之緩衝區的長度，以位元組為單位。

[in] Reserved1

保留的。 必須為零。

[out, optional] ReturnLength

如果不是Null，則為 pPropertyInformation緩衝區中傳回的數位，以位元組為單位。

如果輸出緩衝區太小，呼叫會失敗，且傳回值為 ERROR_MORE_DATA。 pReturnLength所指向的值可用來判斷呼叫成功所需的緩衝區長度下限。

[in] Reserved2

此參數是保留的，而且必須是 Null。

傳回值

如果函式成功，它會傳回 NO_ERROR。

如果函式失敗，它會傳回下列其中一個錯誤碼。

值 意義
ERROR_INVALID_PARAMETER
 保留參數不是零，或pReserved參數不是Null。

要求佇列不支援 Property 參數中指定的 屬性 類型。

pPropertyInformation參數為Null。

PropertyInformationLength參數為零。

應用程式沒有開啟要求佇列的許可權。
ERROR_MORE_DATA
 pPropertyInformation參數所指向之緩衝區的大小，以位元組為單位，無法接收屬性資訊。 再次呼叫函式，且緩衝區的大小至少與 結束時 pReturnLength 所指向的大小相同。
ERROR_NOT_SUPPORTED
 要求佇列的控制碼是 HTTP 1.0 版控制碼。 只有 HTTP 2.0 版和更新版本要求佇列才支援屬性管理。

需求

   
最低支援的用戶端 Windows Vista [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2008 [僅限傳統型應用程式]
目標平台 Windows
標頭 HTTP.h
程式庫 Httpapi.lib
Dll Httpapi.dll

另請參閱

HTTP Server API 2.0 版函式

HttpCloseRequestQueue

HttpCreateRequestQueue

HttpSetRequestQueueProperty

HttpShutdownRequestQueue