LImageViewerCell::GetIconProperties

Summary

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

Syntax

L_INT LImageViewerCell::GetIconProperties(nIconIndex, pDispContainerIconProps, uFlags)

Parameters

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 LImageViewerCell::GetIconProperties 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 LImageViewerCell::GetIconProperties as the pDispContainerIconProps parameter.

To change the properties of a title bar icon, call the LImageViewerCell::SetIconProperties 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

• LImageViewer::Create
• LImageViewer::Destroy
• LImageViewerCell::IsTitlebarIconChecked
• LImageViewerCell::GetTitlebarProperties
• LImageViewerCell::IsTitlebarEnabled
• LImageViewerCell::SetIconProperties
• LImageViewerCell::SetTitlebarProperties
• LImageViewerCell::ShowTitlebar
• LImageViewerCell::CheckTitlebarIcon.

Topics

• Image Viewer Functions: Custom Painting
• Custom Painting

Example

For an example, refer to LImageViewerCell::ShowTitlebar.