L_DispContainerGetCellProperties

#include "ltivw.h"

L_LTIVW_API L_INT L_DispContainerGetCellProperties(hCon, nCellIndex, pCellProperties, uFlags)

HDISPCONTAINER hCon;	/* handle to the container */
L_INT nCellIndex;	/* index of a cell */
pDISPCELLPROPERTIES * pCellProperties;	/* pointer to a cell options structure */
L_UINT uFlags;	/* reserved for future use */

Gets the current properties of the specified cell.

Parameter	Description
hCon	Handle to the container.
nCellIndex	A zero-based index of the cell for which to get the properties.
pCellProperties	Pointer to a DISPCELLPROPERTIES structure to be updated with the current cell properties.
uFlags	Reserved for future use. Pass 0.

Returns

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

Comments

Before calling L_DispContainerGetCellProperties apply the following:

declare a variable of type DISPCELLPROPERTIES.
set DISPCELLPROPERTIES.uStructSize to sizeof(DISPCELLPROPERTIES)
set DISPCELLPROPERTIES.uMask to indicate the properties to be updated with the current values
pass a pointer to the DISPCELLPROPERTIES structure to L_DispContainerGetCellProperties as the pCellProperties parameter.

To set new cell properties, call L_DispContainerSetCellProperties.

For more information on the available properties that can be used to control the behavior of the cell, refer to the DISPCELLPROPERTIES 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.

See Also

Functions:	L_DispContainerCreate, L_DispContainerRemoveCell, L_DispContainerInsertCell, L_DispContainerGetCellCount, L_DispContainerGetWindowHandle, L_DispContainerSetCellBitmapList, L_DispContainerSetCellTag, L_DispContainerSetCellProperties, L_DispContainerGetCellPosition, L_DispContainerRepositionCell, L_DispContainerGetCellBitmapList, L_DispContainerGetCellBounds, L_DispContainerFreezeCell, L_DispContainerSetBounds, L_DispContainerSelectCell, L_DispContainerIsCellSelected, L_DispContainerIsCellFrozen
Topics:	Image Viewer Cells
	Image Viewer Functions: Image Viewer Cells

Example

For an example, refer to L_DispContainerCreate.