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

Comments

Before calling LImageViewer::GetProperties,

• Declare a variable of type DISPCONTAINERPROPERTIES.

• Set DISPCONTAINERPROPERTIES.uStructSize to sizeof(DISPCONTAINERPROPERTIES)

• Set DISPCONTAINERPROPERTIES.uMask to indicate the properties to update with current values

• Pass a pointer to the DISPCONTAINERPROPERTIES structure to LImageViewer::GetProperties as the pDispContainerProp parameter.

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

• 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.

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