The property methods of the IADsTSUserEx interface can be used to examine
and configure Remote Desktop Services user properties. Properties include logon, TerminalServicesHomeDirectory, remote control, session,
and environment properties of the ADsTSUserEx class.
Before calling the methods of this interface, you must call the
IADs::GetInfo method or the
IADs::GetInfoEx method to load the property values of the
ADSI object from the underlying directory store into the property cache. Call
IADs::GetInfo to refresh all the property values for the
class; call IADs::GetInfoEx to refresh the values of
selected properties in the property cache.
After calling the methods of this interface, you must call the
IADs::SetInfo method to save the property value changes in
the persistent store of the underlying directory store.
For more information, see The ADSI Attribute Cache and the
reference section for the ADSI Interfaces. For a general discussion on
property methods, see Interface Property Methods.
The following table lists the property methods of the IADsTSUserEx interface in
vtable order.
Methods
The IADsTSUserEx interface inherits the methods of the IDispatch interface.
In addition, IADsTSUserEx defines the following methods.
Properties
The IADsTSUserEx interface defines the following properties. The preceding table includes access methods for these properties.
| Property | Access type | Description |
|---|
AllowLogon | Read/write | A value that specifies whether the user is allowed to log on to the RD Session Host server. The value is one if logon
is allowed, and zero if logon is not allowed.
|
BrokenConnectionAction | Read/write | A value that specifies the action to be taken when a Remote Desktop Services session limit is reached. The value is one if
the client session should be terminated, and zero if the client session should be disconnected.
|
ConnectClientDrivesAtLogon | Read/write | This property is not supported by Remote Desktop Services.
|
ConnectClientPrintersAtLogon | Read/write | A value that specifies whether to reconnect to mapped client printers at logon. The value is one if reconnection
is enabled, and zero if reconnection is disabled.
|
DefaultToMainPrinter | Read/write | A value that specifies whether to print automatically to the client's default printer. The value is one if
printing to the client's default printer is enabled, and zero if it is disabled.
|
EnableRemoteControl | Read/write | A value that specifies whether to allow remote observation or remote control of the user's Remote Desktop Services
session. For a description of these values, see the
RemoteControl method of
the Win32_TSRemoteControlSetting WMI
class.
|
MaxConnectionTime | Read/write | The maximum duration of the Remote Desktop Services session, in minutes. After the specified number of minutes have
elapsed, the session can be disconnected or terminated.
|
MaxDisconnectionTime | Read/write | The maximum amount of time, in minutes, that a disconnected Remote Desktop Services session remains active on the
RD Session Host server. After the specified number of minutes have elapsed, the session is terminated.
|
MaxIdleTime | Read/write | The maximum amount of time that the Remote Desktop Services session can remain idle, in minutes. After the specified
number of minutes has elapsed, the session can be disconnected or terminated.
|
ReconnectionAction | Read/write | This property is not supported by Remote Desktop Services.
|
TerminalServicesHomeDirectory | Read/write | The root directory for the user. Each user on an RD Session Host server has a unique root directory. This ensures that
application information is stored separately for each user in a multiuser environment.
|
TerminalServicesHomeDrive | Read/write | The root drive for the user. In a network environment, this property is a string that contains a drive
specification (a drive letter followed by a colon) to which the UNC path specified in the
TerminalServicesHomeDirectory property is mapped.
|
TerminalServicesInitialProgram | Read/write | The path and file name of the application that the user wants to start automatically when the user logs on to the
RD Session Host server.
|
TerminalServicesProfilePath | Read/write | The roaming or mandatory profile path to be used when the user logs on to the RD Session Host server.
|
TerminalServicesWorkDirectory | Read/write | The working directory path for the user.
|
Requirements
| Minimum supported client | Windows XP |
|---|
| Minimum supported server | Windows 2000 Server |
|---|
| Header | Tsuserex.h (include Tsuserex.h or Tsuserex_i.c) |
|---|
| Type Library | Tsuserex.tlb |
|---|
| DLL | Tsuserex.dll |
|---|
See Also
- Interface Property Methods
- Active Directory Service Interfaces Scripting
- ADSI Interfaces
- IADs::GetInfo
- IADs::GetInfoEx
- IADs::SetInfo
Send comments about this topic to Microsoft
Build date: 10/19/2009