L_DispContainerGetProperties

#include "ltivw.h"

L_LTIVW_API L_INT L_DispContainerGetProperties(hCon, pDispContainerProp, uFlags)

HDISPCONTAINER hCon;	/* handle to the container */
pDISPCONTAINERPROPERTIES * pDispContainerProp;	/* pointer to a container options structure */
L_UINT uFlags;	/* reserved for future use */

This function gets the current properties of the container.

Parameter	Description
hCon	Handle to the container.
pDispContainerProp	Pointer to a DISPCONTAINERPROPERTIES options structure to be updated with the current properties used to control the behavior of the container.
uFlags	Reserved for future use. Pass 0.

Returns

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

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

LTIVW

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_DispContainerCreate, L_DispContainerDestroy, L_DispContainerSetProperties, L_DispContainerGetHandle, L_DispContainerGetWindowHandle
Topics:	Using the Image Viewer
	Image Viewer Functions: Using the Image Viewer

Example

This function reposition the cells splitters that have been moved by the user in order to make every cell has the same size

#if defined LEADTOOLS_V17_OR_LATER
 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;
}

#else



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

#endif