WTSSetUserConfigW-Funktion (wtsapi32.h)

Artikel
11/20/2024

Ändert Konfigurationsinformationen für den angegebenen Benutzer auf dem angegebenen Domänencontroller oder remotedesktop-Sitzungshostserver (RD-Sitzungshost).

Syntax

BOOL WTSSetUserConfigW(
  [in] LPWSTR           pServerName,
  [in] LPWSTR           pUserName,
  [in] WTS_CONFIG_CLASS WTSConfigClass,
  [in] LPWSTR           pBuffer,
  [in] DWORD            DataLength
);

Parameter

[in] pServerName

Zeiger auf eine mit Null beendete Zeichenfolge, die den Namen eines Domänencontrollers oder 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 Namen des Benutzers enthält, dessen Konfiguration festgelegt wird.

[in] WTSConfigClass

Gibt den Typ der informationen an, die für den Benutzer festgelegt werden sollen. 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 angegebenen Daten beschrieben.

[in] pBuffer

Zeigen Sie auf die Daten, die zum Ändern der Konfiguration des angegebenen Benutzers verwendet werden.

[in] DataLength

Größe des pBuffer- Puffers in TCHARs-.

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.

Wenn der Wert des WTSConfigClass-Parameters einem ganzzahligen Wert in der WTS_CONFIG_CLASS-Aufzählung entspricht, definieren Sie den Wert, der als DWORD-festgelegt werden soll. Wandeln Sie dann den Wert in eine LPWSTR- im Aufruf von WTSSetUserConfigum, wie im folgenden Beispiel gezeigt:

WTSSetUserConfig( strServer.GetBuffer(0), 
                  m_strName.GetBuffer(0), 
                  WTSUserConfigfAllowLogonTerminalServer, 
                  (LPWSTR) &dwEnable, 
                  sizeof(DWORD));

Anmerkung

Der wtsapi32.h-Header definiert WTSSetUserConfig 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

Siehe auch

WTSQueryUserConfig

WTS_CONFIG_CLASS

Freigeben über