In This Topic ▼

L_VecSetBackgroundColor

Summary

Sets the current background color.

Syntax

#include "ltvkrn.h"

L_LVKRN_API L_INT L_VecSetBackgroundColor(pVector, Color)

Parameters

pVECTORHANDLE pVector

Pointer to a vector handle.

L_COLORREF Color

The background color to set.

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

If L_VecPaint is called, with bEraseBkgnd set to TRUE, this color will be used to erase the background.

Required DLLs and Libraries

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

Example

This example will set the background color of a vector handle.

L_LTVKRNTEX_API L_INT VecSetBackgroundColorExample( 
   HWND hWnd, 
   pVECTORHANDLE pVector) 
{ 
   L_INT nRet; 
   CHOOSECOLOR cc;               /* ChooseColor Windows structure */ 
   COLORREF ccCustColors[16];    /* Custom colors */ 
 
   memset( &cc, 0, sizeof( CHOOSECOLOR )); 
   cc.lStructSize    = sizeof( CHOOSECOLOR ); 
   cc.hwndOwner      = hWnd; 
   cc.rgbResult      = L_VecGetBackgroundColor( pVector ); 
   cc.lpCustColors   = ccCustColors; 
   cc.Flags          = CC_RGBINIT; 
 
   nRet = SUCCESS; 
   if( ChooseColor( &cc )) 
      nRet = L_VecSetBackgroundColor( pVector, cc.rgbResult ); 
 
   return nRet; 
}