LContainer::GetMetrics

#include "Ltwrappr.h"

L_INT LContainer::GetMetrics (pMetrics)

pCONTAINERMETRICS pMetrics;

/* pointer to a structure */

Gets the current container metrics information.

Parameter

Description

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:

LContainer::SetMetrics.

Topics:

Getting and Setting Container Properties

Example

L_INT LContainer_GetMetricsExample(LContainer & lcont)
{
   L_INT nRet;
   CONTAINERMETRICS Metrics ;
   HWND hwndOwner ;
   RECT rcClient ;
   /* Get the container owner */
   nRet = lcont.GetOwner (&hwndOwner ) ;
   if(nRet != SUCCESS)
      return nRet;
   /* 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 = lcont.GetMetrics (&Metrics ) ;
   if(nRet != SUCCESS)
      return nRet;
   if ( ! EqualRect ( &rcClient, &Metrics.rcLimits ) )
   {
      CopyRect ( &Metrics.rcLimits, &rcClient ) ;
      /* Set the new metrics */
      nRet = lcont.SetMetrics (&Metrics ) ;
      if(nRet != SUCCESS)
         return nRet;
   }
   return SUCCESS ;
}