IADsTSUserEx interface (tsuserex.h)
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 IADsTSUserEx 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.
Inheritance
The IADsTSUserEx interface inherits from the IDispatch interface.
Methods
The IADsTSUserEx interface has these methods.
| IADsTSUserEx::get_AllowLogon A value that specifies whether the user is allowed to log on to the Remote Desktop Session Host (RD Session Host) server. (Get) |
| IADsTSUserEx::get_BrokenConnectionAction A value that specifies the action to take when a Remote Desktop Services session limit is reached. (Get) |
| IADsTSUserEx::get_ConnectClientDrivesAtLogon A value that specifies if mapped client drives should be reconnected when a Remote Desktop Services session is started. (Get) |
| IADsTSUserEx::get_ConnectClientPrintersAtLogon A value that specifies whether to reconnect to mapped client printers at logon. (Get) |
| IADsTSUserEx::get_DefaultToMainPrinter A value that specifies whether to print automatically to the client's default printer. (Get) |
| IADsTSUserEx::get_EnableRemoteControl A value that specifies whether to allow remote observation or remote control of the user's Remote Desktop Services session. (Get) |
| IADsTSUserEx::get_MaxConnectionTime The maximum duration of the Remote Desktop Services session. After the specified number of minutes have elapsed, the session can be disconnected or terminated. (Get) |
| IADsTSUserEx::get_MaxDisconnectionTime The maximum amount of time that a disconnected Remote Desktop Services session remains active on the Remote Desktop Session Host (RD Session Host) server. After the specified number of minutes have elapsed, the session is terminated. (Get) |
| IADsTSUserEx::get_MaxIdleTime The maximum amount of time that the Remote Desktop Services session can remain idle. After the specified number of minutes has elapsed, the session can be disconnected or terminated. (Get) |
| IADsTSUserEx::get_ReconnectionAction A value that specifies if reconnection to a disconnected Remote Desktop Services session is allowed. (Get) |
| IADsTSUserEx::get_TerminalServicesHomeDirectory The root directory for the user. Each user on a Remote Desktop Session Host (RD Session Host) server has a unique root directory. This ensures that application information is stored separately for each user in a multiuser environment. (Get) |
| IADsTSUserEx::get_TerminalServicesHomeDrive 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 as the root directory is mapped. (Get) |
| IADsTSUserEx::get_TerminalServicesInitialProgram The path and file name of the application that the user wants to start automatically when the user logs on to the Remote Desktop Session Host (RD Session Host) server. (Get) |
| IADsTSUserEx::get_TerminalServicesProfilePath The roaming or mandatory profile path to be used when the user logs on to the Remote Desktop Session Host (RD Session Host) server. (Get) |
| IADsTSUserEx::get_TerminalServicesWorkDirectory The working directory path for the user. (Get) |
| IADsTSUserEx::put_AllowLogon A value that specifies whether the user is allowed to log on to the Remote Desktop Session Host (RD Session Host) server. (Put) |
| IADsTSUserEx::put_BrokenConnectionAction A value that specifies the action to take when a Remote Desktop Services session limit is reached. (Put) |
| IADsTSUserEx::put_ConnectClientDrivesAtLogon A value that specifies if mapped client drives should be reconnected when a Remote Desktop Services session is started. (Put) |
| IADsTSUserEx::put_ConnectClientPrintersAtLogon A value that specifies whether to reconnect to mapped client printers at logon. (Put) |
| IADsTSUserEx::put_DefaultToMainPrinter A value that specifies whether to print automatically to the client's default printer. (Put) |
| IADsTSUserEx::put_EnableRemoteControl A value that specifies whether to allow remote observation or remote control of the user's Remote Desktop Services session. (Put) |
| IADsTSUserEx::put_MaxConnectionTime The maximum duration of the Remote Desktop Services session. After the specified number of minutes have elapsed, the session can be disconnected or terminated. (Put) |
| IADsTSUserEx::put_MaxDisconnectionTime The maximum amount of time that a disconnected Remote Desktop Services session remains active on the Remote Desktop Session Host (RD Session Host) server. After the specified number of minutes have elapsed, the session is terminated. (Put) |
| IADsTSUserEx::put_MaxIdleTime The maximum amount of time that the Remote Desktop Services session can remain idle. After the specified number of minutes has elapsed, the session can be disconnected or terminated. (Put) |
| IADsTSUserEx::put_ReconnectionAction A value that specifies if reconnection to a disconnected Remote Desktop Services session is allowed. (Put) |
| IADsTSUserEx::put_TerminalServicesHomeDirectory The root directory for the user. Each user on a Remote Desktop Session Host (RD Session Host) server has a unique root directory. This ensures that application information is stored separately for each user in a multiuser environment. (Put) |
| IADsTSUserEx::put_TerminalServicesHomeDrive 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 as the root directory is mapped. (Put) |
| IADsTSUserEx::put_TerminalServicesInitialProgram The path and file name of the application that the user wants to start automatically when the user logs on to the Remote Desktop Session Host (RD Session Host) server. (Put) |
| IADsTSUserEx::put_TerminalServicesProfilePath The roaming or mandatory profile path to be used when the user logs on to the Remote Desktop Session Host (RD Session Host) server. (Put) |
| IADsTSUserEx::put_TerminalServicesWorkDirectory The working directory path for the user. (Put) |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista |
| Minimum supported server | Windows Server 2008 |
| Target Platform | Windows |
| Header | tsuserex.h (include Tsuserex.h, Tsuserex_i.c) |