LAnnotation::IsLocked

#include "ltwrappr.h"

virtual L_BOOL LAnnotation::IsLocked(L_VOID)

Gets a value that indicates whether the annotation object is locked. This function is available in the Document/Medical Toolkits.

Returns

TRUE

The object is locked.

FALSE

The object is not locked.

Comments

Only unlocked objects can be locked. If an object is already locked, it will stay locked with its original key. You must pass the same key to LAnnotation::Unlock to unlock the object(s).

An object must be unlocked in order to change its key in the automated mode.

Redact objects must be unlocked to be restored (unrealized). Refer to LAnnContainer::Unrealize.

Required DLLs and Libraries

LTANN

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

Functions:

Class Members

Topics:

Annotation Functions (Document/Medical ): Security

Example

For an example, refer to LAnnotation::Unlock.