Win32_TSClientSetting class

Article
12/11/2020

The Win32_TSClientSetting WMI class defines configuration settings for the Win32_Terminal class related to connection policy.

The following syntax is simplified from MOF code and includes all defined and inherited properties, in alphabetical order. For reference information on methods, see the table of methods later in this topic.

Syntax

[dynamic, provider("Win32_WIN32_TSCLIENTSETTING_Prov"), ClassContext("local|hkey_local_machine\\SYSTEM\\CurrentControlSet\\Control\\TerminalServer\\WinStations"), AMENDMENT]
class Win32_TSClientSetting : Win32_TerminalSetting
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Name;
  string   Status;
  string   TerminalName;
  uint32   ConnectionPolicy;
  uint32   ConnectClientDrivesAtLogon;
  uint32   ConnectPrinterAtLogon;
  uint32   DefaultToClientPrinter;
  uint32   PolicySourceDefaultToClientPrinter;
  uint32   WindowsPrinterMapping;
  uint32   PolicySourceWindowsPrinterMapping;
  uint32   LPTPortMapping;
  uint32   PolicySourceLPTPortMapping;
  uint32   COMPortMapping;
  uint32   PolicySourceCOMPortMapping;
  uint32   DriveMapping;
  uint32   PolicySourceDriveMapping;
  uint32   AudioMapping;
  uint32   PolicySourceAudioMapping;
  uint32   ClipboardMapping;
  uint32   PolicySourceClipboardMapping;
  uint32   ColorDepthPolicy;
  uint32   PolicySourceColorDepthPolicy;
  uint32   ColorDepth;
  uint32   PolicySourceColorDepth;
  uint32   MaxMonitors;
  uint32   MaxXResolution;
  uint32   MaxYResolution;
  uint32   PolicySourceMaxMonitors;
  uint32   PolicySourceMaxResolution;
  uint32   PNPRedirection;
  uint32   PolicySourcePNPRedirection;
  uint32   AudioCaptureRedir;
  uint32   PolicySourceAudioCaptureRedir;
  uint32   VideoPlaybackRedir;
  uint32   PolicySourceVideoPlaybackRedir;
  uint32   AllowDwm;
  uint32   PolicySourceAllowDwm;
  uint32   PolicyAdvancedRemoteAppGraphics;
  uint32   AdvancedRemoteAppGraphics;
  uint32   RemoteSessionProfile;
  uint32   PolicySourceRemoteSessionProfile;
  uint32   AVC444ModePreferred;
  uint32   PolicySourceAvc444ModePreferred;
  uint32   EncodeImageQuality;
  uint32   PolicySourceEncodeImageQuality;
  uint32   HardwareGraphicsAdapter;
  uint32   PolicySourceHardwareGraphicsAdapter;
  uint32   SelectTransport;
  uint32   PolicySourceSelectTransport;
  uint32   SelectNetworkDetect;
  uint32   PolicySourceSelectNetworkDetect;
};

Members

The Win32_TSClientSetting class has these types of members:

Methods
Properties

Methods

The Win32_TSClientSetting class has these methods.

Method	Description
ConnectionSettings	Sets the ConnectClientDrivesAtLogon, ConnectPrinterAtLogon, and DefaultToClientPrinter properties of this class.
SetAllowDwm	Not supported. Windows 7 and Windows Server 2008 R2: Sets the AllowDwm property.
SetClientProperty	Sets the LPTPortMapping, COMPortMapping, AudioMapping, ClipboardMapping, DriveMapping, or WindowsPrinterMapping property.
SetColorDepth	Sets the ColorDepth property.
SetColorDepthPolicy	Sets the ColorDepthPolicy property.
SetMaxMonitors	Sets the MaxMonitors property.
SetMaxXResolution	Sets the MaxXResolution property.
SetMaxYResolution	Sets the MaxYResolution property.

Properties

The Win32_TSClientSetting class has these properties.

AdvancedRemoteAppGraphics

Data type: uint32
Access type: Read/write

Specifies whether to enable advanced RemoteFX graphics for RemoteApp.

Windows Server 2012, Windows 8, Windows Server 2008 R2, Windows 7, Windows Server 2008 and Windows Vista: This property is not available before Windows Server 2012 R2 and Windows 8.1.

FALSE (0)

Advanced graphics are disabled.

TRUE (1)

Advanced graphics are enabled.

AllowDwm

Data type: uint32
Access type: Read-only

This property is not available.

**Windows 7 and Windows Server 2008 R2: **

Specifies whether to enable or disable remote desktop composition. Zero will disable remote desktop composition and a nonzero value will enable it.

Use the SetAllowDwm method to modify this property.

AudioCaptureRedir

Data type: uint32
Access type: Read-only

Specifies whether to allow audio capture redirection.

Windows Server 2008 and Windows Vista: This property is not available before Windows Server 2008 R2 and Windows 7.

FALSE (0)

TRUE (1)

AudioMapping

Data type: uint32
Access type: Read-only

Specifies whether audio mapping is disabled or enabled.

FALSE (0)

Audio mapping is enabled.

TRUE (1)

Audio mapping is disabled.

AVC444ModePreferred

Data type: uint32
Access type: Read/write

Specifies whether AVC444 mode is preferred.

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Server 2008 R2, Windows Vista and Windows Server 2008: This property is not available prior to Windows 10 or Windows Server 2016.

FALSE (0)

TRUE (1)

Caption

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

Short description (one-line string) of the object.

This property is inherited from CIM_ManagedSystemElement.

ClipboardMapping

Data type: uint32
Access type: Read-only

Specifies whether clipboard mapping is disabled or enabled.

FALSE (0)

Clipboard mapping is enabled.

TRUE (1)

Clipboard mapping is disabled.

ColorDepth

Data type: uint32
Access type: Read-only

Specifies the color depth. For possible values, see the SetColorDepth method.

8 bit (1)

15 bit (2)

16 bit (3)

24 bit (4)

32 bit (5)

ColorDepthPolicy

Data type: uint32
Access type: Read-only

Specifies whether to override the user's maximum color setting.

FALSE (0)

Do not override the user's policy.

TRUE (1)

Override the user's policy.

COMPortMapping

Data type: uint32
Access type: Read-only

Specifies whether COM port mapping is disabled or enabled.

FALSE (0)

COM port mapping is enabled.

TRUE (1)

COM port mapping is disabled.

ConnectClientDrivesAtLogon

Data type: uint32
Access type: Read-only

Specifies whether the client's drives will be automatically connected during the logon process.

FALSE (0)

Drives will not be automatically connected.

TRUE (1)

Drives will be automatically connected.

ConnectionPolicy

Data type: uint32
Access type: Read/write

The policy the server uses to retrieve the user connection settings.

Per User (0)

The user's connection settings are in effect.

Server-Override (1)

The user's connection settings are overridden by the server.

ConnectPrinterAtLogon

Data type: uint32
Access type: Read-only

Specifies whether all mapped local printers of the client will be automatically connected during the logon process.

FALSE (0)

Local printers will not be automatically connected.

TRUE (1)

Local printers will be automatically connected.

DefaultToClientPrinter

Data type: uint32
Access type: Read-only

Specifies whether print jobs will be automatically sent to the client's local printer.

FALSE (0)

Print jobs are not to be automatically sent to the client's local printer.

TRUE (1)

Print jobs are to be automatically sent to the client's local printer.

Description

Data type: string
Access type: Read-only

Description of the object.

This property is inherited from CIM_ManagedSystemElement.

DriveMapping

Data type: uint32
Access type: Read-only

Specifies whether drive mapping is disabled or enabled.

FALSE (0)

Drive mapping is enabled.

TRUE (1)

Drive mapping is disabled.

EncodeImageQuality

Data type: uint32
Access type: Read/write

Specifies the image quality for RDP experience.

Windows 7, Windows Server 2008 R2, Windows Vista and Windows Server 2008: This property is not available prior to Windows 8 or Windows Server 2012.

lossless (1)

high (2)

medium (3)

HardwareGraphicsAdapter

Data type: uint32
Access type: Read/write

Specifies whether the RD Session Host server uses the hardware graphics renderer as the default adapter.

Windows 7, Windows Server 2008 R2, Windows Vista and Windows Server 2008: This property is not available prior to Windows 8 or Windows Server 2012.

FALSE (0)

TRUE (1)

InstallDate

Data type: datetime
Access type: Read-only
Qualifiers: Mappingstrings ("MIF.DMTF|ComponentID|001.5")

The date the object was installed. A lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

LPTPortMapping

Data type: uint32
Access type: Read-only

Specifies whether LPT port mapping is disabled or enabled.

FALSE (0)

LPT port mapping is enabled.

TRUE (1)

LPT port mapping is disabled.

MaxMonitors

Data type: uint32
Access type: Read-only

The maximum number of monitors supported by the server. Use the SetMaxMonitors method to modify this property.

Windows Server 2008 and Windows Vista: This property is not available before Windows Server 2008 R2 and Windows 7.

MaxXResolution

Data type: uint32
Access type: Read-only

The maximum X resolution supported by the server. Use the SetMaxXResolution method to modify this property.

Windows Server 2008 and Windows Vista: This property is not available before Windows Server 2008 R2 and Windows 7.

MaxYResolution

Data type: uint32
Access type: Read-only

The maximum Y resolution supported by the server. Use the SetMaxYResolution method to modify this property.

Windows Server 2008 and Windows Vista: This property is not available before Windows Server 2008 R2 and Windows 7.

Name

Data type: string
Access type: Read-only

The name of the object.

This property is inherited from CIM_ManagedSystemElement.

PNPRedirection

Data type: uint32
Access type: Read-only

Specifies whether to allow Plug and Play redirection.

FALSE (0)

Allow Plug and Play redirection.

TRUE (1)

Do not allow Plug and Play redirection.

PolicyAdvancedRemoteAppGraphics

Data type: uint32
Access type: Read-only

Indicates whether the AdvancedRemoteAppGraphics property is configured by the server or group policy.

Windows Server 2012, Windows 8, Windows Server 2008 R2, Windows 7, Windows Server 2008 and Windows Vista: This property is not available before Windows Server 2012 R2 and Windows 8.1.

0 (0x0)

Server

1 (0x1)

Group policy

PolicySourceAllowDwm

Data type: uint32
Access type: Read-only

This property is not available.

**Windows 7 and Windows Server 2008 R2: **

Indicates whether the AllowDwm property is configured by the server or group policy.

0 (0x0)

Server

1 (0x1)

Group policy

PolicySourceAudioCaptureRedir

Data type: uint32
Access type: Read-only

Indicates whether the AudioCaptureRedir property is configured by the server or group policy.

Windows Server 2008 and Windows Vista: This property is not available before Windows Server 2008 R2 and Windows 7.

0 (0x0)

Server

1 (0x1)

Group policy

PolicySourceAudioMapping

Data type: uint32
Access type: Read-only

Indicates whether the AudioMapping property is configured by the server, group policy, or by default.

0 (0x0)

Server

1 (0x1)

Group policy

2 (0x2)

Default

PolicySourceAvc444ModePreferred

Data type: uint32
Access type: Read-only

Indicates how the AVC444ModePreferredis property is configured.

Server

Group Policy

PolicySourceClipboardMapping

Data type: uint32
Access type: Read-only

Indicates whether the ClipboardMapping property is configured by the server, group policy, or by default.

0 (0x0)

Server

1 (0x1)

Group policy

2 (0x2)

Default

PolicySourceColorDepth

Data type: uint32
Access type: Read-only

Indicates whether the ColorDepth property is configured by the server, group policy, or by default.

0 (0x0)

Server

1 (0x1)

Group policy

2 (0x2)

Default

PolicySourceColorDepthPolicy

Data type: uint32
Access type: Read-only

Indicates whether the ColorDepthPolicy property is configured by the server, group policy, or by default.

0 (0x0)

Server

1 (0x1)

Group policy

2 (0x2)

Default

PolicySourceCOMPortMapping

Data type: uint32
Access type: Read-only

Indicates whether the COMPortMapping property is configured by the server, group policy, or by default.

0 (0x0)

Server

1 (0x1)

Group policy

2 (0x2)

Default

PolicySourceDefaultToClientPrinter

Data type: uint32
Access type: Read-only

Indicates whether the DefaultToClientPrinter property is configured by the server, group policy, or by default.

0 (0x0)

Server

1 (0x1)

Group policy

2 (0x2)

Default

PolicySourceDriveMapping

Data type: uint32
Access type: Read-only

Indicates whether the DriveMapping property is configured by the server, group policy, or by default.

0 (0x0)

Server

1 (0x1)

Group policy

2 (0x2)

Default

PolicySourceEncodeImageQuality

Data type: uint32
Access type: Read-only

Indicates how the EncodeImageQualityi is configured.

Windows 7, Windows Server 2008 R2, Windows Vista and Windows Server 2008: This property is not available prior to Windows 8 or Windows Server 2012.

Server

Group Policy

PolicySourceHardwareGraphicsAdapter

Data type: uint32
Access type: Read-only

Indicates how the HardwareGraphicsAdapter is configured.

Windows 7, Windows Server 2008 R2, Windows Vista and Windows Server 2008: This property is not available prior to Windows 8 or Windows Server 2012.

Server

Group Policy

PolicySourceLPTPortMapping

Data type: uint32
Access type: Read-only

Indicates whether the LPTPortMapping property is configured by the server, group policy, or by default.

0 (0x0)

Server

1 (0x1)

Group policy

2 (0x2)

Default

PolicySourceMaxMonitors

Data type: uint32
Access type: Read-only

Indicates whether the MaxMonitors property is configured by the server, group policy, or default.

0 (0x0)

Server

1 (0x1)

Group policy

2 (0x2)

Default

Windows Server 2008 and Windows Vista: This property is not available before Windows Server 2008 R2 and Windows 7.

PolicySourceMaxResolution

Data type: uint32
Access type: Read-only

Indicates whether the MaxXResolution and MaxYResolution properties are configured by the server, group policy, or default.

Windows Server 2008 and Windows Vista: This property is not available before Windows Server 2008 R2 and Windows 7.

0 (0x0)

Server

1 (0x1)

Group policy

2 (0x2)

Default

PolicySourcePNPRedirection

Data type: uint32
Access type: Read-only

Indicates whether the PNPRedirection property is configured by the server or by group policy.

0 (0x0)

Server

1 (0x1)

Group policy

PolicySourceRemoteSessionProfile

Data type: uint32
Access type: Read-only

Indicates how the RemoteSessionProfile is configured.

Windows 7, Windows Server 2008 R2, Windows Vista and Windows Server 2008: This property is unavailable prior to Windows 8 or Windows Server 2012.

Server

Group Policy

PolicySourceSelectNetworkDetect

Data type: uint32
Access type: Read-only

Indicates how the property SelectNetworkDetect is configured.

Windows 7, Windows Server 2008 R2, Windows Vista and Windows Server 2008: This property is not available prior to Windows 8 or Windows Server 2012.

Server

Group Policy

PolicySourceSelectTransport

Data type: uint32
Access type: Read-only

Indicates how the property SelectTransport is configured.

Windows 7, Windows Server 2008 R2, Windows Vista and Windows Server 2008: This property is not available prior to Windows 8 or Windows Server 2012.

Server

Group Policy

PolicySourceVideoPlaybackRedir

Data type: uint32
Access type: Read-only

Indicates whether the VideoPlaybackRedir property is configured by the server or group policy.

Windows Server 2008 and Windows Vista: This property is not available before Windows Server 2008 R2 and Windows 7.

0 (0x0)

Server

1 (0x1)

Group policy

PolicySourceWindowsPrinterMapping

Data type: uint32
Access type: Read-only

Indicates whether the WindowsPrinterMapping property is configured by the server, group policy, or by default.

0 (0x0)

Server

1 (0x1)

Group policy

2 (0x2)

Default

RemoteSessionProfile

Data type: uint32
Access type: Read/write

Specifies the profile for the RDP experience.

Windows 7, Windows Server 2008 R2, Windows Vista and Windows Server 2008: This property is not available prior to Windows 8 or Windows Server 2012.

scale (1)

experience (2)

bandwidth (3)

SelectNetworkDetect

Data type: uint32
Access type: Read/write

Specifies whether network detection is used.

Windows 7, Windows Server 2008 R2, Windows Vista and Windows Server 2008: This property is not available prior to Windows 8 or Windows Server 2012.

used at connect time and in steady state.

disabled at connect time

disabled in steady state

disabled at connect time and in steady state.

SelectTransport

Data type: uint32
Access type: Read/write

Specifies which transport protocols can be used for RDP access to server.

Windows 7, Windows Server 2008 R2, Windows Vista and Windows Server 2008: This property is not available prior to Windows 8 or Windows Server 2012.

Use both UDP and TCP.

Use only TCP.

Use either UDP or TCP.

Status

Data type: string
Access type: Read-only
Qualifiers: MaxLen (10)

Current status of the object. Various operational and nonoperational statuses can be defined. Operational statuses include: "OK", "Degraded", and "Pred Fail" (an element, such as a SMART-enabled hard disk drive, may be functioning properly but predicting a failure in the near future). Nonoperational statuses include: "Error", "Starting", "Stopping", and "Service". The latter, "Service", could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither "OK" nor in one of the other states.

This property is inherited from CIM_ManagedSystemElement.

("OK")

("Error")

("Degraded")

("Unknown")

("Pred Fail")

("Starting")

("Stopping")

("Service")

TerminalName

Data type: string
Access type: Read-only

The name of the terminal.

This property is inherited from Win32_TerminalSetting.

VideoPlaybackRedir

Data type: uint32
Access type: Read-only

Specifies whether to allow video playback redirection.

Windows Server 2008 and Windows Vista: This property is not available before Windows Server 2008 R2 and Windows 7.

FALSE (0)

TRUE (1)

WindowsPrinterMapping

Data type: uint32
Access type: Read-only

Specifies whether printer mapping is disabled or enabled for the client's window.

FALSE (0)

Printer mapping is enabled.

TRUE (1)

Printer mapping is disabled.

Remarks

Be aware that a window station associated with the console session cannot access the methods and properties of this class. If an attempt is made to do so by specifying "Console" as the value of the TerminalName property, methods of this object will return WBEM_E_NOT_SUPPORTED. This error code is also returned if a window station attempts to call methods of this object to add or modify the security properties of the LocalSystem, LocalService, or NetworkService accounts.

To connect to the \root\CIMV2\TerminalServices namespace, the authentication level must include packet privacy. For C/C++ calls, this is an authentication level of RPC_C_AUTHN_LEVEL_PKT_PRIVACY. For Visual Basic and scripting calls, this is an authentication level of WbemAuthenticationLevelPktPrivacy or "pktPrivacy", with a value of six.

The following Visual Basic Scripting Edition (VBScript) example shows how to connect to a remote computer with packet privacy.

strComputer = "RemoteServer1" 
Set objServices = GetObject( _
    "winmgmts:{authenticationLevel=pktPrivacy}!Root/CIMv2/TerminalServices")

Managed Object Format (MOF) files contain the definitions for Windows Management Instrumentation (WMI) classes. MOF files are not installed as part of the Microsoft Windows Software Development Kit (SDK). They are installed on the server when you add the associated role by using the Server Manager. For more information about MOF files, see Managed Object Format (MOF).

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Namespace	Root\CIMv2\TerminalServices
MOF	TSCfgWmi.mof
DLL	TSCfgWmi.dll

Share via

Win32_TSClientSetting class

Syntax

Members

Methods

Properties

Remarks

Requirements

See also

Feedback

Additional resources