HTTPQueryServerSessionProperty 函式 (http.h)

  • 發行項

HttpQueryServerSessionProperty 函式會查詢指定伺服器會話上的伺服器屬性。

語法

HTTPAPI_LINKAGE ULONG HttpQueryServerSessionProperty(
  [in]            HTTP_SERVER_SESSION_ID ServerSessionId,
  [in]            HTTP_SERVER_PROPERTY   Property,
  [out]           PVOID                  PropertyInformation,
  [in]            ULONG                  PropertyInformationLength,
  [out, optional] PULONG                 ReturnLength
);

參數

[in] ServerSessionId

傳回屬性設定的伺服器會話。

[in] Property

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

屬性 意義
HttpServerStateProperty
 查詢伺服器會話的目前狀態。
HttpServerTimeoutsProperty
 查詢伺服器會話連線逾時限制。
HttpServerQosProperty
 查詢伺服器會話的頻寬節流。 根據預設，HTTP 伺服器 API 不會限制頻寬。
HttpServerAuthenticationProperty
 查詢基本、NTLM、交涉和摘要式驗證配置的核心模式伺服器端驗證。
HttpServerChannelBindProperty
 查詢通道系結令牌 (CBT) 屬性。

[out] PropertyInformation

接收屬性數據的緩衝區指標。

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

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

[in] PropertyInformationLength

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

[out, optional] ReturnLength

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

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

傳回值

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

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

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

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

pPropertyInformation 參數為 NULL。

PropertyInformationLength 參數為零。

應用程式沒有查詢伺服器會話屬性的許可權。 只有建立伺服器會話的應用程式可以查詢屬性。
ERROR_MORE_DATA
 pPropertyInformation 參數所指向之緩衝區的大小，以位元組為單位，無法接收屬性數據。 在 exit 時，再次呼叫具有緩衝區的大小，至少與結束時 pReturnLength 所指向的大小相同。

備註

不支持查詢 HttpServerLoggingProperty 。

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

若要在 pPropertyInformation 參數中指定 HttpServerQosProperty 屬性，請將 QosType 設定為 HTTP_QOS_SETTING_INFO 結構內的 HttpQosSettingTypeBandwidth，並在 參數中傳遞此結構的指標。

規格需求

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

另請參閱

HTTP Server API 2.0 版函式

HttpCloseServerSession

HttpCreateServerSession

HttpQueryServerSessionProperty

HttpSetServerSessionProperty