WTSQueryUserConfigA 函式 (wtsapi32.h)
擷取指定域控制器或遠端桌面工作階段主機 (RD 工作階段主機) 伺服器上的指定使用者的組態資訊。
語法
BOOL WTSQueryUserConfigA(
[in] LPSTR pServerName,
[in] LPSTR pUserName,
[in] WTS_CONFIG_CLASS WTSConfigClass,
[out] LPSTR *ppBuffer,
[out] DWORD *pBytesReturned
);
參數
[in] pServerName
包含域控制器或 RD 工作階段主機伺服器名稱之 Null 終止字串的指標。 指定 WTS_CURRENT_SERVER_NAME,以指出應用程式執行所在的 RD 工作階段主機伺服器。
[in] pUserName
包含要查詢之用戶名稱之 Null 終止字串的指標。 若要擷取 RD 工作階段主機伺服器的預設使用者設定,請將此參數設定為 NULL。
Windows Server 2008 和 Windows Vista:將此參數設定為 NULL 會傳回錯誤。
[in] WTSConfigClass
指定要擷取的信息類型。 這個參數可以是來自 WTS_CONFIG_CLASS 列舉類型的其中一個值。 WTS_CONFIG_CLASS 的文件說明每個資訊類型 ppBuffer 中所傳回的數據格式。
[out] ppBuffer
接收所要求資訊的指標之變數指標。 數據的格式和內容取決於 WTSConfigClass 參數中指定的資訊類別。 若要釋放傳回的緩衝區,請呼叫 WTSFreeMemory 函式。
[out] pBytesReturned
接收 ppBuffer 中傳回之資料大小位元組的變數指標,。
傳回值
如果函式成功,則傳回值是非零值。
如果函式失敗,傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。
言論
WTSQueryUserConfig 和 WTSSetUserConfig 函式會傳遞伺服器名稱,而不是句柄,因為使用者帳戶資訊通常位於域控制器上。 若要設定使用者設定資訊,請使用主要域控制器。 您可以呼叫 NetGetDCName 函式,以取得主要域控制器的名稱。 若要查詢使用者設定資訊,您可以使用 NetGetAnyDCName 函式來取得主要或備份域控制器的名稱。
任何域控制器都可以設定或查詢使用者設定資訊。 使用 DsGetDcName 函式來擷取域控制器的名稱。
注意
wtsapi32.h 標頭會根據 UNICODE 預處理器常數的定義,將 WTSQueryUserConfig 定義為自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型的
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows Vista |
支援的最低伺服器 | Windows Server 2008 |
目標平臺 | 窗戶 |
標頭 | wtsapi32.h |
連結庫 | Wtsapi32.lib |
DLL | Wtsapi32.dll |