Share via


IMsRdpClientAdvancedSettings::put_ShadowBitmap (Windows Embedded CE 6.0)

1/6/2010

This method sets a value that indicates whether shadow bitmaps will be used.

Syntax

HRESULT put_ShadowBitmap( 
    LONG shadowBitmap
);

Parameters

  • shadowBitmap
    [in] Specifies whether shadow bitmaps will be used. Set this parameter to a nonzero value to enable this feature, or set it to a value of zero to make this feature unavailable.

Return Value

Returns S_OK if successful.

Remarks

A shadow bitmap effect applies a shadow behind a visual object at a slight offset. A shadow bitmap effect makes the UI element appear like it is lifting off the surface of the display screen.

When in full-screen mode, shadow bitmaps can be used if the full-screen window size is smaller than the desktop size. Otherwise, shadow bitmaps are unavailable in full-screen mode.

A nonzero value enables shadowing, while a value of zero makes it unavailable. Disabling the ShadowBitmap property typically improves performance but can result in artifacts when painting bitmaps on the display screen.

For Windows Embedded CE, the default value is 0 to improve performance.

Requirements

Header mstsax.h, mstsax.idl
Library Mstsax.lib
Windows Embedded CE Windows CE .NET 4.0 and later

See Also

Reference

IMsRdpClientAdvancedSettings Methods for Bitmaps and Caching
IMsRdpClientAdvancedSettings
IMsRdpClientAdvancedSettings::get_ShadowBitmap