In This Topic ▼

L_DispContainerSetCellProperties

Summary

Sets the properties for the specified cell.

Syntax

#include "ltivw.h"

L_LTIVW_API L_INT L_DispContainerSetCellProperties(hCellWnd, pCellProperties, uFlags)

Parameters

L_HWND hCellWnd

A handle to the window that represent the cell which the function effect will be implemented on.

pDISPCELLPROPERTIES pCellProperties

Pointer to the DISPCELLPROPERTIES structure that contains the cell properties to set.

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 hCellWnd by calling the function L_DispContainerInsertCell. 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.
CELL_ALL	[0x30000000] Apply the feature to all cells in the Image Viewer.
CELL_INV_ALL	[0xcfffffff] For internal use only.

Returns

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

Comments

Before calling L_DispContainerSetCellProperties apply the following:

declare a variable of type DISPCELLPROPERTIES.
set DISPCELLPROPERTIES.uStructSize to sizeof(DISPCELLPROPERTIES)
set DISPCELLPROPERTIES.uMask to indicate which properties are to be set (that is, which members of the structure contain valid information)
specify the new property values in the appropriate members.
pass a pointer to the DISPCELLPROPERTIES structure to L_DispContainerSetCellProperties as the pCellProperties parameter.

To get the current properties set for a cell, call L_DispContainerGetCellProperties.

For more information on the actual properties that can be set, refer to the DISPCELLPROPERTIES structure.