In This Topic ▼

LImageViewerCell::GetCellProperties

Summary

Gets the current properties of the specified cell.

Syntax

#include "ltwrappr.h"

L_INT LImageViewerCell::GetCellProperties (pCellProperties, uFlags);

Parameters

pDISPCELLPROPERTIES pCellProperties

Pointer to a DISPCELLPROPERTIES structure to be updated with the current cell properties.

L_UINT uFlags

Flags that determine whether to apply the feature on the one cell only, or more than one cell. This value can only be used when the cell is attached to the LImageViewer through the function LImageViewer::InsertCell. Possible values are:

Value	Meaning
CELL_APPLYTOTHIS	[0x00000000] Apply the feature to this cell only.
CELL_APPLYTOALL	[0x10000000] Apply the feature to all the cells in the Image Viewer.
CELL_APPLYTOSELECTED	[0x20000000] Apply the feature to the selected cells in the Image Viewer.

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 LImageViewerCell::GetCellProperties,

Declare a variable of type DISPCELLPROPERTIES.
Set DISPCELLPROPERTIES.uStructSize to sizeof(DISPCELLPROPERTIES)
Set DISPCELLPROPERTIES.uMask to indicate the properties to update with current values
Pass a pointer to the DISPCELLPROPERTIES structure to LImageViewerCell::GetCellProperties as the pCellProperties parameter.

To set new cell properties, call LImageViewerCell::SetCellProperties.

For more information on the available properties that can be used to control the behavior of the cell, refer to the DISPCELLPROPERTIES structure.