WTSEnumerateListenersA 函式 (wtsapi32.h)
列舉遠端桌面會話主機上的所有遠端桌面服務接聽程式, (RD 工作階段主機) 伺服器上。
語法
BOOL WTSEnumerateListenersA(
[in] HANDLE hServer,
[in] PVOID pReserved,
[in] DWORD Reserved,
[out, optional] PWTSLISTENERNAMEA pListeners,
[in, out] DWORD *pCount
);
參數
[in] hServer
RD 工作階段主機伺服器的句柄。 一律將此參數設定為 WTS_CURRENT_SERVER_HANDLE。
[in] pReserved
此參數已保留備用。 一律將此參數設定為 NULL。
[in] Reserved
此參數已保留備用。 一律將此參數設定為零。
[out, optional] pListeners
接收接聽程式名稱之 WTSLISTENERNAME 變數陣列的指標。
[in, out] pCount
DWORD 變數的指標,其中包含 pListeners 參數所參考數位中的接聽程式名稱數目。 如果接聽程式名稱的數目不明,請將 pListeners 傳遞為 NULL。 函式會傳回為 pListeners 參數所指向之數位配置所需的 WTSLISTENERNAME 變數數目。
傳回值
如果函式成功,則傳回值是非零值。
如果此函式失敗,則傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。
備註
此函式會傳回目前在伺服器上執行的所有接聽程式,包括不支援遠端桌面通訊協定的接聽程式 (RDP) 。
如果接聽程式數目不明,您可以使用 pListeners 設定為 NULL 呼叫此函式。 然後,函式會傳回 pCount 參數中接收所有接聽程式所需的 WTSLISTENERNAME 變數數目。 根據這個數位配置 pListeners 的數位配置 pListeners 的數位配置,然後再次呼叫函式,將 pListeners 設定為新配置的陣列,並將 pCount 設定為第一次呼叫所傳回的數位。
注意
wtsapi32.h 標頭會根據 UNICODE 預處理器常數的定義,將 WTSEnumerateListeners 定義為別名,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows 7 |
最低支援的伺服器 | Windows Server 2008 R2 |
目標平台 | Windows |
標頭 | wtsapi32.h |
程式庫 | Wtsapi32.lib |
Dll | Wtsapi32.dll |