L_DispContainerGetProperties

#include "ltivw.h"

L_LTIVW_API L_INT L_DispContainerGetProperties(hCon, pDispContainerProp, uFlags)

This function gets the current properties of the container.

Parameters

HDISPCONTAINER hCon

Handle to the container.

pDISPCONTAINERPROPERTIES pDispContainerProp

Pointer to a DISPCONTAINERPROPERTIES options structure to be updated with the current properties used to control the behavior of the container.

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

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

Comments

Before calling L_DispContainerGetProperties apply the following:

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

See Also

Functions

Topics

Example

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

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

Help Version 21.0.2020.8.21
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Medical Image Viewer C API Help