The WSProfile type

Top  Previous  Next

 

The complex WSProfile type represents a profile and carries all its information. In order to retrieve, create, delete and update the ThinRDP profiles, you will have to manipulate this WSProfile data structure.

 

Attribute name

Type

Description

Modifiable

ID

string

Profile ID

no

Name

string

Profile name

yes

Enabled

boolean

Set false if you want the profile to be disabled

yes

Unrestricted

boolean

Only the [any computer] profile has this property set to true. It means that the profile will enable the users to choose the computer they will access entering the IP, port and credentials on the connection moment.

no

GuestAllowed

boolean

Set true to make the profile public

yes

IsBuiltIn

boolean

This attribute identifies the [any computer] profile. Only this profile has this attribute set to true.

no

PublicKey

string

Key that identifies a profile .

no

Computer

string

The remote desktop IP and port to connect to

yes

Credentials

TRdpCredentials

Configures the credential mode ThinRDP will operate on.

yes

LogonUserName

string

If the credential mode is set to "crAsk", will use this Username to log in into the computer.

yes

LogonPassword

string

If the credential mode is set to "crAsk", will use this Password to log in into the computer.

yes

ScreenResolution

TRdpScreen

Resolution

Sets the remote desktop resolution.

yes

ScreenWidth

int

Remote desktop screen width.

yes

ScreenHeight

int

Remote desktop screen height.

yes

BPP

TRdpScreenBPP

Color Depth: sets the number of bits per pixel

yes

ImageQuality

TRdpImageQuality

Remote desktop image quality.

 

UnicodeKbd

boolean

Allows for full unicode keyboard charsets. Set to false to connect to xRDP servers.

yes

ConsoleSession

boolean

Set to true to connect to the console session. This requires confirmation from the logged on user and will log out the current session.

yes

WebsocketCompression

boolean

Set to true to enable the compression for the exchanged Websocket data and have the application performance improved.

yes

RelativeMouseTouch

boolean

For mobile devices. Uncheck this option to have a mouse behaviour similar to a desktop mouse in which the cursor will always be positioned under the touch. Leave as true to use relative mouse like a trackpad.

yes

AppMode

TRdpAppMode

Application Mode: sets whether the profile should connect to a specific application

yes

AppCmdLine

string

Specify the complete path to give access the application you want to start upon connection.

yes

AppCmdArgs

string

Arguments to start the application informed on the AppCmdLine field.

yes

AppWorkDir

string

Mark this option if you need to specify a context directory for the program set on the field "Program path and file name"

yes

DesktopBackground

boolean

Set to true to show the original remote desktop background.

yes

VisualStyles

boolean

Set to true to change the Start menu and other Windows features styles.

yes

MenuAnimation

boolean

Set to true to show an animation on the Start menu.

yes

FontSmoothing

boolean

Set to true to make text easier to read, especially the magnified text.

yes

ShowWindowOnDrag

boolean

Set to true to show windows content while dragging them.

yes

DesktopComposition

boolean

Set true to configure the DWM to redirected the desktop drawing to off-screen surfaces in video memory. Also, the desktop will present many visual effects.

yes

PrinterEnabled

boolean

Uncheck this option to disable ThinRDP PDF printer.

yes

PrinterSetAsDefault

boolean

Mark this option to make ThinRDP printer the remote machine default printer.

yes

PrinterName

string

Specify the printer name that you want to be shown on the remote machine's printer list.

yes

PrinterDriver

string

This is the driver to be used by ThinRDP in order to print the remote documents.

The "HP Color LaserJet 2800 Series PS" driver is compatible with 2008 Windows versions. The "HP Color LaserJet 8500 PS" driver is compatible with 2003 Windows versions. If you are not using 2003 or 2008 Windows versions, look for a driver that is already installed on the OS and inform this driver name in this attribute.

yes

Clipboard

boolean

Enables and disables the remote desktop clipboard.

yes

DiskEnabled

boolean

Check this option to have an intermediate disk available on the connections created through this profile.

yes

DiskName

string

This is the name to identify the intermediate disk among the other remote  desktop disks.

yes

DiskAutoDownload

boolean

If set to true, ThinRDP will download automatically any file saved/copied on the  Intermediate disk direction.

yes

SoundEnabled

boolean

Check this option to enable the remote sound to be reproduced within the browser. The remote sound works only with Firefox and Chrome web browsers.

yes

SoundQuality

TRdpSoundQuality

Determines what quality ThinRDP will use to reproduce the remote sound. The highest the quality, the more resources it will require.

yes

Users

string

Windows Authentication Users or Groups that will be granted access to this profile. Separate each user or group by semicolons.

yes