LAnnotation::SetUserData

#include "ltwrappr.h"

virtual L_INT LAnnotation::SetUserData(pUserData, uUserDataSize, uFlags)

L_UCHAR * pUserData;

/* address of binary data to write */

L_UINT uUserDataSize;

/* length of binary data in bytes*/

L_UINT uFlags;

/* flags that determine which objects to process*/

Sets user-defined data of one or more annotation objects.

Parameter

Description

pUserData

Buffer that contains the binary data to write.

uUserDataSize

Length (in bytes) of the binary data to write.

uFlags

Flags that determine which objects to process. Most of the flags apply only to container objects. You can combine values when appropriate by using a bitwise OR ( | ). The following are valid values:

 

Value

Meaning

 

0

Process only the specified object.

 

ANNFLAG_SELECTED

[0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the LAnnotation::IsSelected and LAnnotation::SetSelected functions.

 

ANNFLAG_NOTTHIS

[0x0004] Process only one level of objects within the specified container, not the container itself. If there are containers within the container, they are modified, but the objects within them are not.

 

ANNFLAG_RECURSE

[0x0008] Process objects within a container, and within any subcontainers, down to any level.

 

ANNFLAG_NOTCONTAINER

[0x0002] (Used with ANNFLAG_RECURSE) Process objects within containers, not the containers themselves.

 

ANNFLAG_NOINVALIDATE

[0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Use this function to associate user-defined data with ANY annotation object. User data can be binary or text data, and can be any length. When the annotation object is copied, any user data is also copied. When saving the annotation (LAnnContainer::Save, LAnnContainer::SaveMemory, LAnnContainer::SaveOffset), the user data is saved.

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:

LAnnAutomation::SetAutoCursor, LAnnAutomation::GetAutoCursor, Class Members, LAnnotation::SetAutoSnapCursor, LAnnotation::GetAutoSnapCursor

Topics:

Automated User Interface for Annotations

 

Implementing Annotations

Example

For an example, refer to LAnnotation::GetUserData.