L_DispContainerIsTitlebarIconChecked

#include "ltivw.h"

L_LTIVW_API L_BOOL L_DispContainerIsTitlebarIconChecked(hCon, nCellIndex, nSubCellIndex, nIconIndex, uFlags)

HDISPCONTAINER hCon;

/* handle to the container */

L_INT nCellIndex;

/* index of a cell */

L_INT nSubCellIndex;

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

L_INT nIconIndex;

/* index of the title bar icon */

L_UINT uFlags;

/* reserved for future use */

Determines whether the specific title bar icon of the specific cell or sub-cell is checked or unchecked.

Parameter

Description

hCon

Handle to the container.

nCellIndex

A zero-based index of the cell for which to get the title bar icon status.

nSubCellIndex

A zero-based index into the image list attached to the cell specified in nCellIndex. The status of the icon attached to the sub-cell at this index will be retrieved. Pass -2 to retrieve the status of the icon attached to the active sub-cell.

nIconIndex

A zero-based index of the icon to retrieve its status.

uFlags

Reserved for future use. Pass 0.

Returns

TRUE

The specified icon is checked.

FALSE

The specified icon is not checked, or an error occurred. Refer to Return Codes.

Comments

To check or uncheck a specific title bar icon, call the L_DispContainerCheckTitlebarIcon function.

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_DispContainerDestroy, L_DispContainerGetTitlebarProperties, L_DispContainerIsTitlebarEnabled, L_DispContainerSetIconProperties, L_DispContainerGetIconProperties, L_DispContainerSetTitlebarProperties, L_DispContainerShowTitlebar, L_DispContainerCheckTitlebarIcon

Topics:

Image Viewer Cells

Image Viewer Functions: Image Viewer Cells

Example

For an example, refer to L_DispContainerShowTitlebar.