L_ContainerGetMetrics

#include "LtCon.h"

L_LTCON_API L_INT L_ContainerGetMetrics(pContainer, pMetrics)

pCONTAINERHANDLE pContainer;

/* pointer to a container handle */

pCONTAINERMETRICS pMetrics;

/* pointer to a structure */

Gets the current container metrics information.

Parameter

Description

pContainer

Pointer to a container handle.

pMetrics

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

Returns

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

See Also

Functions:

L_ContainerSetMetrics.

Topics:

Getting and Setting Container Properties

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;
   
}