LImageViewer::IsSubCellFrozen

#include "ltwrappr.h"

L_BOOL LImageViewer::IsSubCellFrozen(nCellIndex, nSubCellIndex, uFlags)

L_INT nCellIndex;

/* index of a cell */

L_INT nSubCellIndex;

/* index into the image list attached to the cell */

L_UINT uFlags;

/* reserved for future use */

Retrieves a value that indicates whether a sub-cell has been frozen.

Parameter

Description

nCellIndex

A zero-based index of the cell that contains the sub-cell, which is being tested to see if it is frozen.

nSubCellIndex

A zero-based index into the image list attached to the cell specified in nCellIndex. This function will determine whether the sub-cell is frozen. Pass -2 to retrieve the frozen status of the selected sub-cell.

uFlags

Reserved for future use. Pass 0.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

The properties of a frozen sub-cell cannot be modified except by manually setting them using LImageViewer::SetActionProperties.

To freeze a sub-cell, call LImageViewer::FreezeSubCell. To freeze a cell, call LImageViewer::FreezeCell. To retrieve a value that indicates whether the entire cell has been frozen, call LImageViewer::IsCellFrozen.

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:

LImageViewer::FreezeSubCell, LImageViewer::FreezeCell, LImageViewer::SelectCell, LImageViewer::IsCellSelected, LImageViewer::Create, LImageViewer::GetCellCount, LImageViewer::GetCellWindowHandle, LImageViewer::SetCellBitmapList, LImageViewer::SetCellTag, LImageViewer::SetCellProperties, LImageViewer::InsertCell, LImageViewer::RemoveCell, LImageViewer::GetCellProperties, LImageViewer::RepositionCell, LImageViewer::GetCellPosition, LImageViewer::GetCellBitmapList, LImageViewer::GetCellBounds

Topics:

Image Viewer Cells

 

Window Control/Image Viewer Functions: Image Viewer Cells

Example

For an example, refer to LImageViewer::FreezeSubCell.