IRDPSRAPISharingSession2::ColorDepth property

Retrieves or sets the color depth for the shared session.

This property is read/write.

Syntax

HRESULT put_ColorDepth(
  [in]  long colorDepth
);

HRESULT get_ColorDepth(
  [out] long *pColorDepth
);

Property value

Specifies the color depth of the session in bits per pixel (bpp). The color depth is always 32. If you specify any other value, the color depth is set to 32 bpp.

Windows Server 2008 R2:  Possible values are 16 and 24. If you specify a value of 8, the color depth is set to 16 bpp.

Windows Server 2008 and Windows Vista:  Possible values are 8, 16, and 24 bpp.

Error codes

If the method succeeds, the return value is S_OK. Otherwise, the return value is an error code.

Requirements

See also

IRDPSRAPISharingSession2

IRDPSRAPISharingSession