wpSetLockupBackground - Parameters

somSelf (WPDesktop *) - input

Pointer to the object on which the method is being invoked.

Points to an object of class WPDesktop.

pszImageFileName (PSZ) - input

The name of the background image file (or NULL if none is defined).

ulImageMode (ULONG) - input

The following are the image modes:

BACKGROUND_NORMAL_IMAGE

Normal image.
BACKGROUND_TILED_IMAGE
Tiled image.
BACKGROUND_SCALED_IMAGE
Scaled image.

ulScaleFactor (ULONG) - input

Scaling factor if the image mode is SCALED_IMAGE.

ulBackgroundType (ULONG) - input

Can be one of the following background types:

BACKGROUND_COLOR_ONLY

Color only, no image.
BACKGROUND_IMAGE
Type of image (see image modes).

lBackgroundColor (LONG) - input

Background color as an encoded RGB value.

The RGB value must be presented as a 6-digit hex value in the format 0xRRGGBB where RR, GG, and BB are the red, green, and blue values ranging between 0x00 and 0xFF (0-255).

There is no return value for this method.

---

[Back: wpSetLockupBackground - Return Value]
[Next: wpSetLockupBackground - Usage]