HttpQueryUrlGroupProperty 函式 (HTTP.h)

發行項
08/24/2023

HttpQueryUrlGroupProperty 函式會查詢指定 URL 群組上的屬性。

語法

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

參數

[in] UrlGroupId

傳回屬性設定的 URL 群組識別碼。

[in] Property

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

屬性	意義
HttpServerAuthenticationProperty	查詢已啟用的伺服器端驗證配置。
HttpServerTimeoutsProperty	查詢 URL 群組連線逾時限制。
HttpServerStateProperty	查詢 URL 群組的目前狀態。狀態可以啟用或停用。
HttpServerQosProperty	此值會對應至QosType設定為HttpQosSettingTypeBandwidth或HttpQosSettingTypeConnectionLimit的泛型HTTP_QOS_SETTING_INFO結構。如果 HttpQosSettingTypeBandwidth，則會查詢 URL 群組的頻寬節流。如果 HttpQosSettingTypeConnectionLimit，請隨時查詢為 URL 群組提供的最大未處理連線數目。
HttpServerChannelBindProperty	查詢通道系結權杖 (CBT) 屬性。

[out] PropertyInformation

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

pPropertyInformation 會根據所查詢的屬性，指向下列其中一個屬性資訊結構。

屬性	結構
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

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

[out, optional] ReturnLength

pPropertyInformation緩衝區中傳回的大小，以位元組為單位。

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

傳回值

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

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

值	意義
ERROR_INVALID_PARAMETER	URL 群組不支援在 Property 參數中指定的屬性類型。 UrlGroupId參數無法識別有效的伺服器 URL 群組。 pPropertyInformation參數為Null。 PropertyInformationLength參數為零。應用程式沒有查詢 URL 群組屬性的許可權。只有建立 URL 群組的應用程式可以查詢屬性。
ERROR_MORE_DATA	pPropertyInformation參數所指向之緩衝區的大小，以位元組為單位，無法接收屬性資訊。再次呼叫函式，且緩衝區的大小至少與結束時 pReturnLength 所指向的大小相同。

值

意義

ERROR_INVALID_PARAMETER

URL 群組不支援 在 Property 參數中指定的屬性類型。

UrlGroupId參數無法識別有效的伺服器 URL 群組。

pPropertyInformation參數為Null。

PropertyInformationLength參數為零。

應用程式沒有查詢 URL 群組屬性的許可權。只有建立 URL 群組的應用程式可以查詢屬性。

ERROR_MORE_DATA

pPropertyInformation參數所指向之緩衝區的大小，以位元組為單位，無法接收屬性資訊。再次呼叫函式，且緩衝區的大小至少與 結束時 pReturnLength 所指向的大小相同。

備註

不支援查詢 HttpServerLoggingProperty 。

需求


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