L_VecGetBackgroundColor

#include "lvkrn.h"

L_LVKRN_API COLORREF L_VecGetBackgroundColor(pVector)

const pVECTORHANDLE pVector;

/* pointer to a vector handle */

Gets the current background color.

Parameter

Description

pVector

Pointer to a vector handle.

Returns

COLORREF value of the current background color.

Comments

This function returns the current background color. If L_VecPaint is called with the bEraseBkgnd parameter set t o TRUE, this is the color that is used to erase the background.

Required DLLs and Libraries

LVKRN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

L_VecSetBackgroundColor, L_VecPaint, L_VecAttachToWindow

Example

This example will get the current background color and display its RGB values in a message box. 

L_INT VecGetBackgroundColorExample(pVECTORHANDLE pVector)
{
   COLORREF  color;            /* Background color */
   L_TCHAR   szBuffer[ 80 ];   /* Buffer */

   /* Get background color */
   color = L_VecGetBackgroundColor( pVector );

   /* Show it in a message box */
   wsprintf( szBuffer, TEXT("%02x, %02x, %02x"),
             GetRValue( color ), GetGValue( color ), GetBValue( color ) );
               
   MessageBox( NULL, szBuffer, TEXT("Background Color"), 0 );

   return SUCCESS;
}