WTSEnumerateSessionsA 函式 (wtsapi32.h)

  • 發行項

擷取遠端桌面會話主機上的會話清單， (RD 工作階段主機) 伺服器。

語法

BOOL WTSEnumerateSessionsA(
  [in]  HANDLE             hServer,
  [in]  DWORD              Reserved,
  [in]  DWORD              Version,
  [out] PWTS_SESSION_INFOA *ppSessionInfo,
  [out] DWORD              *pCount
);

參數

[in] hServer

RD 工作階段主機伺服器的句柄。

注意 您可以使用 WTSOpenServer 或 WTSOpenServerEx 函式來擷取特定伺服器的句柄，或 WTS_CURRENT_SERVER_HANDLE 使用裝載應用程式的 RD 會話主機伺服器。
 

[in] Reserved

此參數已保留備用。 它必須是零。

[in] Version

列舉要求的版本。 此參數必須是 1。

[out] ppSessionInfo

表示所擷取會話 之WTS_SESSION_INFO 結構的陣列指標。 若要釋放傳回的緩衝區，請呼叫 WTSFreeMemory 函式 。

工作階段權限：

  • 若要列舉會話，您必須啟用查詢資訊許可權。 如需詳細資訊，請參閱 遠端桌面服務許可權。
  • 若要變更會話的許可權，請使用遠端桌面服務組態系統管理工具。
  • 若要列舉在裝載於 RD 虛擬化主機伺服器上的虛擬機上執行的工作階段，您必須是 RD 虛擬化主機伺服器上的 Administrators 群組成員。

[out] pCount

ppSessionInfo 參數中傳回之WTS_SESSION_INFO結構的指標。

傳回值

如果此函式失敗，則傳回零。 如果此函式成功，則會傳回非零值。

若要取得擴充的錯誤資訊，請呼叫 GetLastError。

備註

注意

wtsapi32.h 標頭會根據 UNICODE 預處理器常數的定義，將 WTSEnumerateSessions 定義為別名，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

規格需求

需求 值
最低支援的用戶端 Windows Vista
最低支援的伺服器 Windows Server 2008
目標平台 Windows
標頭 wtsapi32.h
程式庫 Wtsapi32.lib
Dll Wtsapi32.dll
API 集合 ext-ms-win-session-wtsapi32-l1-1-0 (於 Windows 8)

另請參閱

WTS_SESSION_INFO