In This Topic ▼

L_ContainerGetMetrics

Summary

Gets the current container metrics information.

Syntax

#include "LtCon.h"

L_LTCON_API L_INT L_ContainerGetMetrics(pContainer, pMetrics)

Parameters

pCONTAINERHANDLE pContainer

Pointer to a container handle.

pCONTAINERMETRICS pMetrics

Pointer to CONTAINERMETRICS structure to be updated with the current container metrics information.

Returns

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

Required DLLs and Libraries

LTCON
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

L_INT ContainerGetMetricsExample(pCONTAINERHANDLE pContainer) 
{ 
   L_INT nRet; 
   CONTAINERMETRICS  Metrics ; 
   HWND              hwndOwner ; 
   RECT              rcClient ; 
 
   /* Get the container owner */ 
   nRet = L_ContainerGetOwner ( pContainer, &hwndOwner ) ; 
   if(nRet == SUCCESS) 
   { 
      /* Get the owner client area */ 
      GetClientRect ( hwndOwner, &rcClient ) ; 
 
      /* Initiate the container metrics */ 
      Metrics.nSize  = sizeof ( CONTAINERMETRICS ) ; 
      Metrics.dwMask = CMF_LIMITS ; 
 
      /* Get the container metrics */ 
      nRet = L_ContainerGetMetrics ( pContainer, &Metrics ) ; 
      if(nRet != SUCCESS) 
         return nRet; 
 
      if ( ! EqualRect ( &rcClient, &Metrics.rcLimits ) ) 
      { 
 
         CopyRect ( &Metrics.rcLimits, &rcClient ) ; 
 
         /* Set the new metrics */ 
         nRet = L_ContainerSetMetrics( pContainer, &Metrics ) ; 
      } 
   } 
 
   return nRet; 
    
}