LImageViewer::GetProperties

#include "ltwrappr.h"

L_INT LImageViewer::GetProperties (pDispContainerProp, uFlags);

Gets the current properties of the container.

Parameters

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. To get extended error information, call GetLastError, and refer to Return Codes.

Comments

Before calling LImageViewer::GetProperties,

To set new container properties, call LImageViewer::SetProperties.

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 will give all the cells in the container the same size by resting the position of the cells' splitters, which might have been moved by the user.

L_INT LImageViewer_GetPropertiesExample(LImageViewer& ImageViewer)  
 
{ 
   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 = ImageViewer.GetProperties(&DispContainerProp, 0);  
   if(nRet != SUCCESS) 
      return nRet; 
 
   nRet = ImageViewer.SetProperties(&DispContainerProp, 0);  
   if(nRet != SUCCESS) 
      return nRet; 
 
   return SUCCESS; 
} 

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

LEADTOOLS Medical Image Viewer C++ Class Library Help