L_LTANN_API L_INT L_AnnGetAutoMenuState(hObject, nObjectType, pEnable, pEnableFlags, uBits)
Retrieves the automation menu state.
Handle to the annotation object.
Constant that specifies an object's type. For descriptions of possible object types, refer to Types of Annotations. This parameter is valid only if
hObject is an automation object.
An array of bit flags that is updated with values that specify whether the corresponding menu item specified in pEnableFlags is enabled or disabled. The bits in the pEnable array are ordered just like the bits in the
pEnableFlags array. Therefore, if pEnableFlags & 0x40 == 1 is true, and pEnable & 0x40 == 1 is also true, then the ANNAUTOTEXT_MENU_CUT menu item will be displayed, based on the values of
hObject and uFlags.
An array of bit flags that is updated with values that indicate which menu items have been changed from their default behavior. The bits are ordered from most significant to least significant. Therefore, pEnableFlags contains flags for menu items 0, 1, 2, 3, 4,5, 6, 7. This corresponds to:
For example, if pEnableFlags & 0x40 == 1 is true, the ANNAUTOTEXT_MENU_CUT menu item has been changed from its default behavior. To determine whether the menu item is enabled or disabled, check the corresponding bit flag in
Number of bits in the
pEnable arrays. The number of bytes pointed to by pEnable and pEnableFlags can be determined using the following equation: Bytes = (uBits + 7) / 8.
|SUCCESS||The function was successful.|
|< 1||An error occurred. Refer to Return Codes.|
If a bit in the
pEnableFlags array is set to 1, then the corresponding bit in the
pEnable array determines whether the corresponding menu item will be displayed or not. If the corresponding bit in pEnable is one, the menu item will be displayed, provided the menu item string is not NULL. If the corresponding bit in pEnable is 0, the corresponding menu item will not be displayed.
If a bit in pEnableFlags is 0, the corresponding bit in pEnable is ignored, and the menu item is displayed or not displayed based on the default behavior.
Required DLLs and Libraries
For an example, refer to L_AnnSetAutoMenuState.
Medical Web Viewer .NET
.NET, Java, Android, and iOS/macOS Assemblies
C API/C++ Class Libraries