WTSQuerySessionInformationA 函式 (wtsapi32.h)
擷取指定遠端桌面會話主機 (RD 工作階段主機) 伺服器上的指定工作階段資訊。 它可用來查詢本機和遠端 RD 工作階段主機伺服器上的作業階段資訊。
語法
BOOL WTSQuerySessionInformationA(
[in] HANDLE hServer,
[in] DWORD SessionId,
[in] WTS_INFO_CLASS WTSInfoClass,
[out] LPSTR *ppBuffer,
[out] DWORD *pBytesReturned
);
參數
[in] hServer
RD 工作階段主機伺服器的句柄。 指定 由 WTSOpenServer 函式開啟的句柄，或指定 WTS_CURRENT_SERVER_HANDLE 來指出應用程式執行所在的 RD 會話主機伺服器。
[in] SessionId
遠端桌面服務會話標識碼。 表示呼叫端應用程式正在執行 (或目前工作階段) 指定 WTS_CURRENT_SESSION的作業階段。 只有在取得本地伺服器上的會話資訊時，才指定 WTS_CURRENT_SESSION 。 如果在遠端伺服器上查詢會話資訊時指定 WTS_CURRENT_SESSION ，傳回的會話資訊將會不一致。 請勿使用傳回的數據。
您可以使用 WTSEnumerateSessions 函 式，擷取指定 RD 工作話主機伺服器上所有會話的標識碼。
若要查詢其他使用者會話的資訊，您必須具有 [查詢資訊] 許可權。 如需詳細資訊，請參閱 遠端桌面服務許可權。 若要修改會話的許可權，請使用遠端桌面服務組態系統管理工具。
[in] WTSInfoClass
WTS_INFO_CLASS 列舉的值，指出在 WTSQuerySessionInformation 函式呼叫中擷取的會話資訊類型。
[out] ppBuffer
接收所要求資訊指標之變數的指標。 數據的格式和內容取決於 WTSInfoClass 參數中指定的資訊類別。 若要釋放傳回的緩衝區，請呼叫 WTSFreeMemory 函式 。
[out] pBytesReturned
接收 ppBuffer 中傳回之數據大小的變數指標，以位元組為單位。
傳回值
如果函式成功，則傳回值是非零值。
如果此函式失敗，則傳回值為零。 若要取得擴充的錯誤資訊，請呼叫 GetLastError。
備註
若要在遠端桌面服務執行時擷取目前會話的會話標識碼，請呼叫 WTSQuerySessionInformation 並針對 SessionId 參數指定WTS_CURRENT_SESSION，併為 WTSInfoClass 參數指定 WTSSessionId。 會話標識碼將會在 ppBuffer 參數中傳回。 如果遠端桌面服務未執行， 則對 WTSQuerySessionInformation 的 呼叫會失敗。 在此情況下，您可以藉由呼叫 ProcessIdToSessionId 函式來擷取目前的會話標識碼。
若要判斷您的應用程式是否在實體控制台上執行，您必須為 SessionId 參數指定WTS_CURRENT_SESSION，並將 WTSClientProtocolType 指定為 WTSInfoClass 參數。 如果 ppBuffer 為 “0”，會話會附加至實體控制台。
注意
wtsapi32.h 標頭會根據 UNICODE 預處理器常數的定義，將 WTSQuerySessionInformation 定義為別名，自動選取此函式的 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) |