WTSCLIENTA structure (wtsapi32.h)
Contains information about a Remote Desktop Connection (RDC) client.
Syntax
typedef struct _WTSCLIENTA {
CHAR ClientName[CLIENTNAME_LENGTH + 1];
CHAR Domain[DOMAIN_LENGTH + 1];
CHAR UserName[USERNAME_LENGTH + 1];
CHAR WorkDirectory[MAX_PATH + 1];
CHAR InitialProgram[MAX_PATH + 1];
BYTE EncryptionLevel;
ULONG ClientAddressFamily;
USHORT ClientAddress[CLIENTADDRESS_LENGTH + 1];
USHORT HRes;
USHORT VRes;
USHORT ColorDepth;
CHAR ClientDirectory[MAX_PATH + 1];
ULONG ClientBuildNumber;
ULONG ClientHardwareId;
USHORT ClientProductId;
USHORT OutBufCountHost;
USHORT OutBufCountClient;
USHORT OutBufLength;
CHAR DeviceId[MAX_PATH + 1];
} WTSCLIENTA, *PWTSCLIENTA;
Members
ClientName[CLIENTNAME_LENGTH + 1]
The NetBIOS name of the client computer.
Domain[DOMAIN_LENGTH + 1]
The domain name of the client computer.
UserName[USERNAME_LENGTH + 1]
The client user name.
WorkDirectory[MAX_PATH + 1]
The folder for the initial program.
InitialProgram[MAX_PATH + 1]
The program to start on connection.
EncryptionLevel
The security level of encryption.
ClientAddressFamily
The address family. This member can be AF_INET, AF_INET6, AF_IPX, AF_NETBIOS, or AF_UNSPEC.
ClientAddress[CLIENTADDRESS_LENGTH + 1]
The client network address.
HRes
Horizontal dimension, in pixels, of the client's display.
VRes
Vertical dimension, in pixels, of the client's display.
ColorDepth
Color depth of the client's display. For possible values, see the ColorDepth member of the WTS_CLIENT_DISPLAY structure.
ClientDirectory[MAX_PATH + 1]
The location of the client ActiveX control DLL.
ClientBuildNumber
The client build number.
ClientHardwareId
Reserved.
ClientProductId
Reserved.
OutBufCountHost
The number of output buffers on the server per session.
OutBufCountClient
The number of output buffers on the client.
OutBufLength
The length of the output buffers, in bytes.
DeviceId[MAX_PATH + 1]
The device ID of the network adapter.
Remarks
For the ClientAddressFamily member, AF_INET (IPv4) will return in string format, for example "127.0.0.1". AF_INET6 (IPv6) will return in binary form.
Note
The wtsapi32.h header defines WTSCLIENT 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 Vista with SP1 |
Minimum supported server | Windows Server 2008 |
Header | wtsapi32.h |