L_DispContainerGetIconProperties

#include "ltivw.h"

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

HWND hCellWnd;	/* handle to the cell window */
L_INT nIconIndex;	/* index of an icon */
pDISPCONTAINERTITLEBARICONPROPS pDispContainerIconProps;	/* pointer to a structure */
L_UINT uFlags;	/* reserved for future use */

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

Parameter	Description
hCellWnd	A handle to the window that represents the cell on which the function's effect will be applied.
nIconIndex	A zero-based index of the icon in the title bar to retrieve its properties.
pDispContainerIconProps	Pointer to a DISPCONTAINERTITLEBARICONPROPS structure to be updated with the specific icon properties.
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_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.