LImageViewerCell::IsSubCellFrozen

#include "ltwrappr.h"

L_BOOL LImageViewerCell::IsSubCellFrozen(nSubCellIndex, uFlags)

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

nSubCellIndex

A zero-based index into the image list attached to the cell. 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 LImageViewerCell::SetActionProperties.

To freeze a sub-cell, call LImageViewerCell::FreezeSubCell. To freeze a cell, call LImageViewerCell::FreezeCell. To retrieve a value that indicates whether the entire cell has been frozen, call LImageViewerCell::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:

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

Topics:

Image Viewer Cells

 

Window Control/Image Viewer Functions: Image Viewer Cells

Example

For an example, refer to LImageViewerCell::FreezeSubCell.