L_DispContainerSetIconProperties

#include "ltivw.h"

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

HDISPCONTAINER hCon;

/* handle to the container */

L_INT nIconIndex;

/* index of the icon */

pDISPCONTAINERTITLEBARICONPROPS pDispContainerIconProps;

/* pointer to the title bar icon structure */

L_UINT uFlags;

/* reserved for future use */

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

Parameter

Description

hCon

Handle to the container.

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.

pDispContainerIconProps

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

uFlags

Reserved for future use. Pass 0.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Before calling L_DispContainerSetIconProperties 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 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.

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_DispContainerGetIconProperties L_DispContainerGetTitlebarProperties, L_DispContainerIsTitlebarEnabled, L_DispContainerSetTitlebarProperties, L_DispContainerShowTitlebar, L_DispContainerCheckTitlebarIcon

Topics:

Image Viewer Cells

Image Viewer Functions: Image Viewer Cells

Example

For an example, refer to L_DispContainerShowTitlebar.