HttpSetServerSessionProperty 函式 (http.h)

  • 發行項

HttpSetServerSessionProperty 函式會設定新的伺服器會話屬性，或修改指定伺服器會話上的現有屬性。

語法

HTTPAPI_LINKAGE ULONG HttpSetServerSessionProperty(
  [in] HTTP_SERVER_SESSION_ID ServerSessionId,
  [in] HTTP_SERVER_PROPERTY   Property,
  [in] PVOID                  PropertyInformation,
  [in] ULONG                  PropertyInformationLength
);

參數

[in] ServerSessionId

設定屬性的伺服器會話。

[in] Property

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

屬性 意義
HttpServerStateProperty
 修改或設定伺服器會話的狀態。 狀態可以啟用或停用;默認狀態已啟用。
HttpServerTimeoutsProperty
 修改或設定伺服器會話連線逾時限制。
HttpServerQosProperty
 修改或設定伺服器會話的頻寬節流。 根據預設，HTTP 伺服器 API 不會限制頻寬。
注意此值會對應至 QosType 設定為 HttpQosSettingTypeBandwidth 的泛型HTTP_QOS_SETTING_INFO結構。
 
HttpServerLoggingProperty
 啟用或停用伺服器會話的記錄。 此屬性只會設定集中式 W3C 和集中式二進位記錄。 根據預設，不會啟用記錄。
HttpServerAuthenticationProperty
 啟用基本、NTLM、交涉和摘要式驗證配置的核心模式伺服器端驗證。
HttpServerExtendedAuthenticationProperty
 啟用 Kerberos 驗證配置的核心模式伺服器端驗證。
HttpServerChannelBindProperty
啟用使用通道系結令牌的伺服器端驗證， (CBT) 。

[in] PropertyInformation

緩衝區的指標，其中包含屬性數據。

pPropertyInformation 會根據所設定的屬性，指向下表所列的屬性數據結構。

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

[in] PropertyInformationLength

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

傳回值

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

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

值 意義
ERROR_INVALID_PARAMETER
 伺服器會話不支援 Property 參數中指定的 屬性 類型。

pPropertyInformation 參數為 NULL。

PropertyInformationLength 參數為零。

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

應用程式沒有設定伺服器會話屬性的許可權。 只有建立伺服器會話的應用程式可以設定屬性。

備註

伺服器會話是最上層組態容器，適用於套用至所有在它們下建立的URL群組的組態數據。 伺服器會話是使用 HttpCreateServerSession 建立的。

pPropertyInformation 參數會指向所設定屬性類型的組態結構。 PropertyInformationLength 參數會指定組態結構的大小，以位元組為單位。 例如，設定 HttpServerTimeoutsProperty 時， pPropertyInformation 參數必須指向至少等於 HTTP_TIMEOUT_LIMIT_INFO 結構大小的緩衝區。

規格需求

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

另請參閱

HTTP Server API 2.0 版函式

HttpCloseServerSession

HttpCreateServerSession

HttpQueryServerSessionProperty

HttpSetServerSessionProperty