WpQueryFldrBackground

This method is specific to Version 4, or higher, of the OS/2 operating system.

This instance method returns the current values for the folder background.

Syntax

wpQueryFldrBackground(somSelf, ppszImageFileName, pulImageMode, pulScaleFactor, pulBackgroundType, plBackgroundColor)

Parameters

somSelf (WPFolder *) - input

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

Points to an object of class WPFolder.

ppszImageFileName (PSZ *) - output

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

pulImageMode (ULONG *) - output

The image mode.

• BACKGROUND_NORMAL_IMAGE Normal image.
• BACKGROUND_TILED_IMAGE Tiled image.
• BACKGROUND_SCALED_IMAGE Scaled image.

pulScaleFactor (ULONG *) - output

The scaling factor for scaled image mode.

pulBackgroundType (ULONG *) - output

The background type.

• BACKGROUND_COLOR_ONLY The background is color only (no image).
• BACKGROUND_IMAGE The background is an image.

plBackgroundColor (LONG *) - output

The RGB value of the background color.

Returns

rc (none) - returns

There is no return value for this method. The values for the folder background are returned in the parameters.

How to Override

This method is generally not overridden.

Usage

This method can be called at any time in order to determine the background bitmap definition for the folder.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPFolder *somSelf; /* Pointer to the object on which the method is being invoked. */

PSZ pszImageFileName;
ULONG ulImageMode;
ULONG ulScaleFactor;
ULONG ulBackgroundType;
LONG lBackgroundColor;

wpQueryFldrBackground(somSelf,
          &pszImageFileName,
          &ulImageMode,
          &ulScaleFactor,
          &ulBackgroundType,
          &lBackgroundColor);
/* pszImageFileName contains the pointer to the name of the image file
 * ulImageMode is BACKGROUND_NORMAL_IMAGE,
 * BACKGROUND_TILED_IMAGE,
 * or BACKGROUND_SCALED_IMAGE
 * ulScaleFactor is a number between 1 and 20
 * ulBackgroundType is BACKGROUND_COLOR_ONLY or BACKGROUND_IMAGE
 * lBackgroundColor is an encoded RGB color value
 */

Related Methods

• wpSetFldrBackground