In This Topic ▼

LVectorWindow::GetBackgroundColor

Summary

Gets the current background color.

Syntax

#include "ltwrappr.h"

L_INT LVectorWindow::GetBackgroundColor(pColor)

Parameters

L_COLOR * pColor

Pointer to an L_COLOR variable to be updated with the background color.

Returns

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

Comments

This function returns the current background color. LVectorWindow::Free() uses this color 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

Assumes pVectorWindow points to a valid LVectorWindow object.

L_INT LVectorWindow__GetBackgroundColorExample(LVectorWindow *pVectorWindow) 
{ 
   L_INT    nRet; 
   L_TCHAR  szTemp[100]; 
   L_COLOR  color; 
 
   nRet = pVectorWindow->GetBackgroundColor(&color); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   wsprintf(szTemp, TEXT("Background color: %x"), color); 
 
   MessageBox(NULL, szTemp, TEXT(""), MB_OK); 
 
   return SUCCESS; 
}