WTSCONFIGINFOA structure (wtsapi32.h)

  • Article

Contains information about a Remote Desktop Services session. This structure is returned by the WTSQuerySessionInformation function when you specify "WTSConfigInfo" for the WTSInfoClass parameter.

Syntax

typedef struct _WTSCONFIGINFOA {
  ULONG version;
  ULONG fConnectClientDrivesAtLogon;
  ULONG fConnectPrinterAtLogon;
  ULONG fDisablePrinterRedirection;
  ULONG fDisableDefaultMainClientPrinter;
  ULONG ShadowSettings;
  CHAR  LogonUserName[USERNAME_LENGTH + 1];
  CHAR  LogonDomain[DOMAIN_LENGTH + 1];
  CHAR  WorkDirectory[MAX_PATH + 1];
  CHAR  InitialProgram[MAX_PATH + 1];
  CHAR  ApplicationName[MAX_PATH + 1];
} WTSCONFIGINFOA, *PWTSCONFIGINFOA;

Members

version

This member is reserved.

fConnectClientDrivesAtLogon

This member is reserved.

fConnectPrinterAtLogon

This member is reserved.

fDisablePrinterRedirection

Specifies whether the client can use printer redirection.

0

Enable client printer redirection.

1

Disable client printer redirection.

fDisableDefaultMainClientPrinter

Specifies whether the printer connected to the client is the default printer for the user.

0

The printer connected to the client is not the default printer for the user.

1

The printer connected to the client is the default printer for the user.

ShadowSettings

The remote control setting. Remote control allows a user to remotely monitor the on-screen operations of another user. This member can be one of the following values.

0

Remote control is disabled.

1

The user of remote control has full control of the user's session, with the user's permission.

2

The user of remote control has full control of the user's session; the user's permission is not required.

3

The user of remote control can view the session remotely, with the user's permission; the remote user cannot actively control the session.

4

The user of remote control can view the session remotely but not actively control the session; the user's permission is not required.

LogonUserName[USERNAME_LENGTH + 1]

A null-terminated string that contains the user name used in automatic logon scenarios.

LogonDomain[DOMAIN_LENGTH + 1]

A null-terminated string that contains the domain name used in automatic logon scenarios.

WorkDirectory[MAX_PATH + 1]

A null-terminated string that contains the path of the working directory of the initial program.

InitialProgram[MAX_PATH + 1]

A null-terminated string that contains the name of the program to start immediately after the user logs on to the server.

ApplicationName[MAX_PATH + 1]

This member is reserved.

Remarks

Note

The wtsapi32.h header defines WTSCONFIGINFO as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows 7
Minimum supported server Windows Server 2008 R2
Header wtsapi32.h

See also

WTSQuerySessionInformation