CB_CONNECTION_INFO structure

Contains information about an incoming connection request. This structure is used with the IConnectionBrokerClient::GetTargetInfo method.

Syntax

typedef struct {
  WCHAR            UserName[CB_USERNAME_LENGTH];
  WCHAR            Domain[CB_DOMAINNAME_LENGTH];
  WCHAR            InitialProgram[CB_INITAPP_LENGTH];
  CB_RESOURCE_TYPE Resource;
  WCHAR            PluginName[CB_PLUGINNAME_LENGTH];
  WCHAR            FarmName[CB_FARMNAME_LENGTH];
  DWORD            dwVendorInfoLength;
  PBYTE            pVendorSpecificInfo;
} CB_CONNECTION_INFO, *PCB_CONNECTION_INFO;

Members

UserName

The name of the user requesting a session.

Domain

The name of the domain that UserName is a member of.

InitialProgram

The fully qualified path and file name of the initial program that is started when the session is started. Set this member to an empty string if no initial program should be started.

Resource

A value of the CB_RESOURCE_TYPE enumeration that specifies the type of resource that the incoming connection is connecting to. If the PluginName member is NULL, this member is used to by the Remote Desktop Connection Broker to determine which plug-in to invoke for determining the target computer.

PluginName

The name of the plug-in to invoke to determine the target computer. If this parameter is NULL, the Resource member is used to determine which plug-in to invoke.

FarmName

The name of the farm that contains the computers, one of which will be the target computer where the connection will be redirected.

dwVendorInfoLength

This member is reserved for future use.

pVendorSpecificInfo

This member is reserved for future use.

Requirements

Requirement	Value
Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Header	Cbclient.h

See also

IConnectionBrokerClient::GetTargetInfo