L_DispContainerGetProperties

#include "ltivw.h"

L_LTIVW_API L_INT L_DispContainerGetProperties(hCon, pDispContainerProp, uFlags)

This function gets the current properties of the container.

Returns

Comments

Before calling L_DispContainerGetProperties apply the following:

• declare a variable of type DISPCONTAINERPROPERTIES.

• set DISPCONTAINERPROPERTIES.uStructSize to sizeof(DISPCONTAINERPROPERTIES)

• set DISPCONTAINERPROPERTIES.uMask to indicate the properties to be updated with the current values.

• pass a pointer to the DISPCONTAINERPROPERTIES structure to L_DispContainerGetProperties as the pDispContainerProp parameter.

To set new container properties, call L_DispContainerSetProperties.

For more information on the available properties that can be used to control the behavior of the container, refer to the DISPCONTAINERPROPERTIES structure.

Required DLLs and Libraries

L_INT DispContainerGetPropertiesExample(HDISPCONTAINER hCon) 
{ 
   L_INT nRet; 
   DISPCONTAINERPROPERTIES DispContainerProp; 
   DispContainerProp.uStructSize = sizeof(DISPCONTAINERPROPERTIES); 
   DispContainerProp.uMask = DCPF_NUMCOLS | DCPF_NUMROWS; 
   // Call this function in order to retrieve the rows and columns count. 
   nRet = L_DispContainerGetProperties(hCon, &DispContainerProp, 0); 
   if(nRet != SUCCESS) 
      return nRet; 
   nRet = L_DispContainerSetProperties (hCon, &DispContainerProp, 0); 
   if(nRet != SUCCESS) 
      return nRet; 
   return SUCCESS; 
}