L_DispContainerGetIconProperties

Summary

Retrieves the properties of the specific icon in the title bar.

Syntax

L_LTIVW_API L_INT L_DispContainerGetIconProperties(hCellWnd, nIconIndex, pDispContainerIconProps, uFlags)

Parameters

L_HWND hCellWnd

A handle to the window that represents the cell on which the function's effect will be applied.

L_INT nIconIndex

A zero-based index of the icon in the title bar to retrieve its properties.

pDISPCONTAINERTITLEBARICONPROPS pDispContainerIconProps

Pointer to a DISPCONTAINERTITLEBARICONPROPS structure to be updated with the specific icon properties.

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

Comments

Before calling L_DispContainerGetIconProperties the user should:

1. Declare a variable of type DISPCONTAINERTITLEBARICONPROPS.
2. Set the pDISPCONTAINERTITLEBARICONPROPS.uStructSize member to the value of sizeof(DISPCONTAINERTITLEBARICONPROPS)
3. Set the DISPCONTAINERTITLEBARICONPROPS.uMask member value to indicate what the members will be updated with the current values.
4. Pass a pointer to the DISPCONTAINERTITLEBARICONPROPS structure to L_DispContainerGetIconProperties as the pDispContainerIconProps parameter.

To change the properties of a title bar icon, call the L_DispContainerSetIconProperties function.

For more information on the available icon properties, refer to the DISPCONTAINERTITLEBARICONPROPS 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_DispContainerDestroy
• L_DispContainerIsTitlebarIconChecked
• L_DispContainerGetTitlebarProperties
• L_DispContainerIsTitlebarEnabled
• L_DispContainerSetIconProperties
• L_DispContainerSetTitlebarProperties
• L_DispContainerShowTitlebar
• L_DispContainerCheckTitlebarIcon

Topics

• Image Viewer Cells
• Image Viewer Functions: Image Viewer Cells

Example

For an example, refer to L_DispContainerShowTitlebar.