LImageViewerCell::SetIconProperties

Summary

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

Syntax

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

Parameters

L_INT nIconIndex

A zero-based index of the icon in the title bar to change its properties. Pass -1 to set the properties to all icons.

pDISPCONTAINERTITLEBARICONPROPS pDispContainerIconProps

Pointer to the DISPCONTAINERTITLEBARICONPROPS structure that contains the icon properties to change.

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

Comments

Before calling LImageVieweCellr::SetIconProperties the user should:

1. Declare a variable of type DISPCONTAINERTITLEBARICONPROPS.
2. Set the DISPCONTAINERTITLEBARICONPROPS.uStructSize member to the value of sizeof(DISPCONTAINERTITLEBARICONPROPS)
3. Set the DISPCONTAINERTITLEBARICONPROPS.uMask member value to indicate what the members will be changed with the new values.
4. Pass a pointer to the DISPCONTAINERTITLEBARPROPS structure to LImageViewerCell::SetIconProperties as the pDispContainerIconProps parameter.

To retrieve the properties of the specific icon in the title bar, call the LImageViewerCell::GetIconProperties function.

For more information on the available title bar 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::GetIconProperties
• LImageViewerCell::GetTitlebarProperties
• LImageViewerCell::IsTitlebarEnabled
• LImageViewerCell::SetTitlebarProperties
• LImageViewerCell::ShowTitlebar
• LImageViewerCell::CheckTitlebarIcon

Topics

• Image Viewer Functions: The Title Bar Feature
• The Title Bar Feature

Example

For an example, refer to LImageViewerCell::ShowTitlebar.