wpQueryIconTextBackgroundColor

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

This instance method returns the current color being used for the icon text background.

Syntax

_wpQueryIconTextBackgroundColor(somSelf)

Parameters

somSelf (WPFolder *) - input: Pointer to the object on which the method is being invoked.; Points to an object of class WPFolder.

Returns

rc (ULONG) - returns: The **RGB** color value of the current color being used for the icon text background.; 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).

How to Override

This method is generally not overridden.

Usage

This method can be called at any time in order to determine the background text color used for normal text in **Icon**, **Tree**, or **Details View** of the folder.

Example Code

#define INCL_WINWORKPLACE
#include <os2.h>

WPFolder *somSelf; /* Pointer to the object on which the method is being invoked. */
ULONG rc; /* The RGB color value of the current color being used for the icon text background. */

rc = _wpQueryIconTextBackgroundColor(somSelf);

/* Example code provided in the source: */
  ULONG ulBackgroundColor;

  ulBackgroundColor = _wpQueryIconTextBackgroundColor(somSelf);
  /* ulBackgroundColor is an encoded RGB color value */

Related Methods