LImageViewer::GetIconProperties
#include "ltwrappr.h"
L_INT LImageViewer::GetIconProperties(nIconIndex, pDispContainerIconProps, uFlags)
L_INT nIconIndex; |
/* index of an icon */ |
pDISPCONTAINERTITLEBARICONPROPS pDispContainerIconProps; |
/* pointer to a DISPCONTAINERTITLEBARICONPROPS structure */ |
L_UINT uFlags; |
/* reserved for future use */ |
Retrieves the properties of the specific icon in the title bar. This function is available only in the Medical Imaging Suite toolkits.
Parameter |
Description |
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 LImageViewer::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 LImageViewer::GetIconProperties as the pDispContainerIconProps parameter. |
To change the properties of a title bar icon, call the LImageViewer::SetIconProperties 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. |
See Also
Example
For an example, refer to LImageViewer::ShowTitlebar.