L_AnnGetRestrictToContainer

Summary

Determines whether the annotation object is restricted to the container.

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetRestrictToContainer(hObject, pbRestrict)

Parameters

HANNOBJECT hObject

Handle to the annotation object.

L_BOOL *pbRestrict

Pointer to a boolean value that specifies whether to restrict the object to the container. Possible values are:

Value Meaning
TRUE Restrict the object to the container.
FALSE Do not restrict the object to the container.

Returns

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

Comments

Determines whether one or more annotation objects is restricted to the container. If an object is restricted to the container, then no part of that object can be moved outside of the container using automation.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

For an example, refer to L_AnnSetRestrictToContainer.

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.