Skip to main content
IMsRdpClient::ColorDepth property

The color depth (in bits per pixel) for the control's connection.

This property is read/write.

Syntax


HRESULT put_ColorDepth(
  [in]   LONG colorDepth
);

HRESULT get_ColorDepth(
  [out]  LONG pcolorDepth
);

Property value

The color depth. Values include 8, 15, 16, 24, and 32 bits per pixel.

Error codes

If the methods succeed, S_OK is returned. Any other HRESULT value indicates that the call failed.

Remarks

This property cannot be set when the control is connected.

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

Type library

Mstscax.dll

DLL

Mstscax.dll

IID

IID_IMsRdpClient is defined as 92b4a539-7115-4b7c-a5a9-e5d9efc2780a

See also

IMsRdpClient2
IMsRdpClient3
IMsRdpClient4
IMsRdpClient5
IMsRdpClient6
IMsRdpClient7
IMsRdpClient8
IMsRdpClient