LImageViewerCell::GetIconProperties

Summary

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

Syntax

#include "ltwrappr.h"

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

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

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

See Also

Functions

Topics

Example

For an example, refer to LImageViewerCell::ShowTitlebar.

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Medical Image Viewer C++ Class Library Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.