In This Topic ▼

L_DispContainerSetIconProperties

Summary

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

#include "ltivw.h"

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

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

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

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

Reserved for future use. Pass 0.

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Before calling L_DispContainerSetIconProperties the user should:

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

To retrieve the properties of the specific icon in the title bar, call the L_DispContainerGetIconProperties function.

For more information on the available title bar icon properties, refer to the DISPCONTAINERTITLEBARICONPROPS structure.