IMsRdpClientAdvancedSettings::LoadBalanceInfo property (Windows)

IMsRdpClientAdvancedSettings::LoadB...

IMsRdpClientAdvancedSettings::LoadBalanceInfo property

Applies to: desktop apps only

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. 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.

This property is read/write.

Syntax

HRESULT put_LoadBalanceInfo(
  [in]   BSTR newLBInfo
);

HRESULT get_LoadBalanceInfo(
  [out]  BSTR *pLBInfo
);

Property value

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

Error codes

Returns S_OK if successful.

Remarks

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

Requirements

Minimum supported client	Windows XP
Minimum supported server	Windows Server 2003
IID	IID_IMsRdpClientAdvancedSettings is defined as 3c65b4ab-12b3-465b-acd4-b8dad3bff9e2

Syntax

Property value

Error codes

Remarks

Requirements

See also