WTSQueryUserConfigA-Funktion (wtsapi32.h)
Ruft Konfigurationsinformationen für den angegebenen Benutzer auf dem angegebenen Domänencontroller oder remotedesktop-Sitzungshostserver (RD Session Host) ab.
Syntax
BOOL WTSQueryUserConfigA(
[in] LPSTR pServerName,
[in] LPSTR pUserName,
[in] WTS_CONFIG_CLASS WTSConfigClass,
[out] LPSTR *ppBuffer,
[out] DWORD *pBytesReturned
);
Parameter
[in] pServerName
Zeigen Sie auf eine mit Null beendete Zeichenfolge, die den Namen eines Domänencontrollers oder eines RD-Sitzungshostservers enthält. Geben Sie WTS_CURRENT_SERVER_NAME an, um den RD-Sitzungshostserver anzugeben, auf dem Ihre Anwendung ausgeführt wird.
[in] pUserName
Zeigen Sie auf eine mit Null beendete Zeichenfolge, die den zu abfragenden Benutzernamen enthält. Um die Standardbenutzereinstellungen für den RD-Sitzungshostserver abzurufen, legen Sie diesen Parameter auf NULL-fest.
Windows Server 2008 und Windows Vista: Festlegen dieses Parameters auf NULL gibt einen Fehler zurück.
[in] WTSConfigClass
Gibt den Typ der abzurufenden Informationen an. Dieser Parameter kann einer der Werte aus dem WTS_CONFIG_CLASS Enumerationstyp sein. In der Dokumentation für WTS_CONFIG_CLASS wird das Format der in ppBuffer für jeden Informationstyp zurückgegebenen Daten beschrieben.
[out] ppBuffer
Zeiger auf eine Variable, die einen Zeiger auf die angeforderten Informationen empfängt. Das Format und der Inhalt der Daten hängen von der im WTSConfigClass Parameter angegebenen Informationsklasse ab. Rufen Sie zum Freigeben des zurückgegebenen Puffers die WTSFreeMemory-Funktion auf.
[out] pBytesReturned
Zeiger auf eine Variable, die die Größe der in ppBuffer-zurückgegebenen Daten in Byte empfängt.
Rückgabewert
Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Wert ungleich Null.
Wenn die Funktion fehlschlägt, ist der Rückgabewert null. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.
Bemerkungen
Die WTSQueryUserConfig und WTSSetUserConfig- Funktionen werden anstelle eines Handles einen Servernamen übergeben, da sich Benutzerkontoinformationen häufig auf einem Domänencontroller befinden. Verwenden Sie den primären Domänencontroller, um Benutzerkonfigurationsinformationen festzulegen. Sie können die NetGetDCName--Funktion aufrufen, um den Namen des primären Domänencontrollers abzurufen. Zum Abfragen von Benutzerkonfigurationsinformationen können Sie die NetGetAnyDCName--Funktion verwenden, um den Namen eines primären oder Sicherungsdomänencontrollers abzurufen.
Jeder Domänencontroller kann Benutzerkonfigurationsinformationen festlegen oder abfragen. Verwenden Sie die DsGetDcName--Funktion, um den Namen eines Domänencontrollers abzurufen.
Anmerkung
Der wtsapi32.h-Header definiert WTSQueryUserConfig als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.
Anforderungen
| Anforderung | Wert |
|---|---|
| mindestens unterstützte Client- | Windows Vista |
| mindestens unterstützte Server- | Windows Server 2008 |
| Zielplattform- | Fenster |
| Header- | wtsapi32.h |
| Library | Wtsapi32.lib |
| DLL- | Wtsapi32.dll |