Gets the current properties of the container.
#include "ltwrappr.h"
L_INT LImageViewer::GetProperties (pDispContainerProp, uFlags);
Pointer to a DISPCONTAINERPROPERTIES options structure to be updated with the current properties used to control the behavior of the container.
Reserved for future use. Pass 0.
Value | Meaning |
---|---|
SUCCESS | The function was successful. |
< 1 | An error occurred. To get extended error information, call GetLastError, and refer to Return Codes. |
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.
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;
}