wpQueryLockupBackground - Parameters

somSelf (WPDesktop *) - input

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

Points to an object of class WPDesktop.

ppszImageFileName (PSZ *) - in/out

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

pulImageMode (ULONG *) - in/out

Pointer to one of the following image modes:

BACKGROUND_NORMAL_IMAGE

Normal image.
BACKGROUND_TILED_IMAGE
Tiled image.
BACKGROUND_SCALED_IMAGE
Scaled image.

pulScaleFactor (ULONG *) - in/out

Pointer to the scaling factor if the image mode is SCALED_IMAGE.

pulBackgroundType (ULONG *) - in/out

Pointer to one of the following background types:

BACKGROUND_COLOR_ONLY

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

plBackgroundColor (LONG *) - in/out

Pointer to the background color as an encoded RGB value.

The RGB value is 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).

The values are returned in the areas pointed to by the individual parameters.

---

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