IMsRdpClientAdvancedSettings::LoadBalanceInfo property

Specifies the load balancing cookie that will be placed in the X.224 Connection Request packet in the Remote Desktop Session Host (RD Session Host) server protocol connection sequence.

This property is read/write.

Syntax

HRESULT put_LoadBalanceInfo(
  [in]  BSTR newLBInfo
);

HRESULT get_LoadBalanceInfo(
  [out] BSTR *pLBInfo
);

Property value

Pointer to the new cookie. For more information, see the remarks section.

Error codes

Returns S_OK if successful.

Remarks

The load balancing information is used by load balancing routers to choose the best server for the client when using farms of RD Session Host servers. The RD Session Host server itself does not use this information and will discard it.

The cookie uses the following, case-sensitive, syntax:

Cookie: msts=IpAddressAndPortNumber\r\n

Where IpAddressAndPortNumber is the IP address and port number, in network byte order.

For example, the cookie used to access the IP address of 172.31.249.216, port number 3389 is as follows:

Cookie: msts=3640205228.15629.0000\r\n

The final four zeros are optional and are reserved. The final decimal point is required, as are the trailing carriage return and linefeed. The length of the string, in characters, must be an even multiple of 2, so add a space if necessary.

If no cookie is supplied, the default is Cookie: mstshash=UserName\r\n.

For more information about Remote Desktop Web Connection, see Requirements for Remote Desktop Web Connection.

Requirements

Minimum supported client
Windows Vista
Minimum supported server
Windows Server 2008
Type library
MsTscAx.dll
DLL
MsTscAx.dll
IID
IID_IMsRdpClientAdvancedSettings is defined as 3c65b4ab-12b3-465b-acd4-b8dad3bff9e2

See also

IMsRdpClientAdvancedSettings2

IMsRdpClientAdvancedSettings3

IMsRdpClientAdvancedSettings4

IMsRdpClientAdvancedSettings5

IMsRdpClientAdvancedSettings6

IMsRdpClientAdvancedSettings7

IMsRdpClientAdvancedSettings8

IMsRdpClientAdvancedSettings