LImageListControl::GetBackColor

Summary

Gets the current ImageList Controls background color.

Syntax

#include "ltwrappr.h"

L_INT LImageListControl::GetBackColor(pcrBack)

Parameters

COLORREF * pcrBack

Pointer to a variable to be updated with the background color of the control.

Returns

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

Comments

Before using this function, you must allocate a variable of type COLORREF and pass the address of this variable in pcrBack.

The variable pointed to by pcrBack will be updated with the ImageList Control's current background color.

Required DLLs and Libraries

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

Platforms

Win32, x64.

Example

L_INT LImageListControl__GetBackColorExample(HWND hParent) 
{ 
   L_INT nRet; 
   LImageListControl m_ImgList; 
   // set back color to RED 
   COLORREF crTest; 
 
   if(m_ImgList.CreateControl(hParent,0) == NULL) 
      return FAILURE; 
 
   nRet = m_ImgList.GetBackColor(&crTest); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   if(crTest != RGB(255,0,0)) 
   { 
      nRet = m_ImgList.SetBackColor(RGB(255,0,0)); 
      if(nRet != SUCCESS) 
         return nRet; 
      ::RedrawWindow(m_ImgList.m_hWnd, NULL, NULL, RDW_INVALIDATE); 
   } 
   return SUCCESS; 
}