In This Topic ▼

L_AnnCreateItem

Summary

Creates an annotation object in a container.

Syntax

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnCreateItem(hContainer, uObjectType, fVisible, phObject)

Parameters

HANNOBJECT hContainer

Handle to the annotation object that is the container for the object to be created.

L_UINT uObjectType

The type of annotation object to create. For descriptions of object types, refer to Types of Annotations.

L_BOOL fVisible

Flag that indicates whether the object will be visible. Possible values are:

Value	Meaning
TRUE	The annotation object will be visible with default properties.
FALSE	The annotation object will not be visible.

pHANNOBJECT phObject

Address of the variable to be updated with the handle to the annotation object.

Returns

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

Comments

(Document and Medical) Before calling this function, you must declare a variable of data type HANNOBJECT. Then, pass the address of the variable in the phObject parameter. This function will update the variable with the handle of the new annotation object.

You must use the L_AnnSet... functions to initialize the object after it is created.

You should not call this function during processing of WM_LTANNEVENT if wParam equals LTANNEVENT_REMOVE or LTANNEVENT_INSERT, or during the ANNENUMCALLBACK callback function