L_AnnGetAutoMenuItemEnable

Summary

Retrieves a value that indicates whether the specified menu item is enabled or disabled.

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetAutoMenuItemEnable(hObject, nObjectType, uItem, puEnable)

Parameters

HANNOBJECT hObject

Handle to the annotation object.

L_INT nObjectType

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.

L_UINT uItem

Constant that specifies the menu or dialog box item to enable or disable. For lists of constants and their default values, refer to the following:

L_UINT * puEnable

Address of a variable to be updated with a value that indicates whether the specified menu item has been enabled or disabled for the object. Possible values are:

Value Meaning
ANNMENU_ENABLED Enable the menu item.
ANNMENU_DISABLED Disable the menu item.
ANNMENU_DEFAULT Enable or disable the menu item, based on the setting for the object type.

Returns

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

Comments

If for the specified object, the menu items enable state is ANNMENU_DEFAULT, the function determines whether the enable state has been set for objects of the specified type. If the enable state for objects of the specified type is also ANNMENU_DEFAULT, the function determines whether the enable state has been set for ANNOBJECT_ALL. If this is also ANNMENU_DEFAULT, the function determines whether the menu item text is NULL or not NULL. If it is NULL, the function updates puEnable with ANNMENU_DISABLE. If the menu item is not NULL, the function updates puEnable with ANNMENU_ENABLE.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

For an example, refer to L_AnnSetAutoMenuItemEnable.

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

LEADTOOLS Raster Imaging C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.