HttpSetUrlGroupProperty 函式 (HTTP.h)

發行項
08/24/2023

HttpSetUrlGroupProperty 函式會設定新的屬性，或修改指定 URL 群組上的現有屬性。

語法

HTTPAPI_LINKAGE ULONG HttpSetUrlGroupProperty(
  [in] HTTP_URL_GROUP_ID    UrlGroupId,
  [in] HTTP_SERVER_PROPERTY Property,
  [in] PVOID                PropertyInformation,
  [in] ULONG                PropertyInformationLength
);

參數

[in] UrlGroupId

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

[in] Property

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

屬性	意義
HttpServerAuthenticationProperty	使用基本、NTLM、交涉和摘要式驗證配置，啟用 URL 群組的伺服器端驗證。
HttpServerExtendedAuthenticationProperty	使用 Kerberos 驗證配置啟用 URL 群組的伺服器端驗證。
HttpServerQosProperty	此值會對應至QosType設定為HttpQosSettingTypeBandwidth或HttpQosSettingTypeConnectionLimit的泛型HTTP_QOS_SETTING_INFO結構。如果 HttpQosSettingTypeBandwidth，請修改或設定 URL 群組的頻寬節流。如果 HttpQosSettingTypeConnectionLimit，請隨時修改或設定 URL 群組所提供未完成的連線數目上限。
HttpServerBindingProperty	修改或設定 URL 群組與要求佇列的關聯。
HttpServerLoggingProperty	修改或設定 URL 群組的記錄。
HttpServerStateProperty	修改或設定 URL 群組的狀態。狀態可以啟用或停用。
HttpServerTimeoutsProperty	修改或設定 URL 群組的連線逾時限制。
HttpServerChannelBindProperty	啟用使用通道系結權杖的伺服器端驗證， (CBT) 。

[in] PropertyInformation

緩衝區的指標，其中包含屬性資訊。

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

屬性	結構
HttpServerAuthenticatonProperty	HTTP_SERVER_AUTHENTICATION_INFO
HttpServerExtendedAuthenticationProperty	HTTP_SERVER_AUTHENTICATION_INFO
HttpServerQosProperty	HTTP_QOS_SETTING_INFO
HttpServerBindingProperty	HTTP_BINDING_INFO
HttpServerLoggingProperty	HTTP_LOGGING_INFO
HttpServerStateProperty	HTTP_STATE_INFO
HttpServerTimeoutsProperty	HTTP_TIMEOUT_LIMIT_INFO
HttpServerChannelBindProperty	HTTP_CHANNEL_BIND_INFO

[in] PropertyInformationLength

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

傳回值

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

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

值	意義
ERROR_INVALID_PARAMETER	URL 群組不支援在 Property 參數中指定的屬性類型。 pPropertyInformation參數為Null。 PropertyInformationLength參數為零。 UrlGroupId參數不包含有效的伺服器會話。應用程式沒有設定 URL 群組屬性的許可權。只有建立 URL 群組的應用程式可以設定屬性。

值

意義

ERROR_INVALID_PARAMETER

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

pPropertyInformation參數為Null。

PropertyInformationLength參數為零。

UrlGroupId參數不包含有效的伺服器會話。

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

備註

建立 URL 群組之後，它必須與要求佇列相關聯，才能接收要求。若要將 URL 群組與要求佇列產生關聯，應用程式會呼叫 HttpSetUrlGroupProperty 與 HttpServerBindingProperty 屬性。如果未設定此屬性，則不會將 URL 群組的相符要求傳遞至要求佇列，而 HTTP 伺服器 API 會產生 503 回應。

需求


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