IMsTscAx::DesktopHeight property

Article
12/11/2020

Specifies the current control's height, in pixels, on the initial remote desktop.

This property is read/write.

Syntax

HRESULT put_DesktopHeight(
  [in]  LONG newVal
);

HRESULT get_DesktopHeight(
  [out] LONG *pVal
);

Property value

The new height, in pixels.

Error codes

Return S_OK if successful.

Remarks

Setting the DesktopHeight property is optional, but it must be set before calling the Connect method. If a desktop height is not specified, or is set to zero, the desktop height is set to the height of the control. The minimum and maximum values are dependent upon the operating system version of the Remote Desktop client.

Windows 8/Windows Server 2012: 200 minimum, 8192 maximum
Windows 7/Windows Server 2008: 200 minimum, 2048 maximum
Windows Vista: 200 minimum, 1200 maximum

After a connection is established, any changes to the control's height do not change the height of the remote desktop. Instead, the control brings up scroll bars or centers the remote desktop, as appropriate. To change the desktop size of an active connection, use the IMsRdpClient8::Reconnect method.

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

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Type library	MsTscAx.dll
DLL	MsTscAx.dll
IID	IID_IMsTscAx is defined as 8C11EFAE-92C3-11D1-BC1E-00C04FA31489