LAnnAutomation::SetPointOptions

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::SetPointOptions(pPointOptions, uFlags)

pANNPOINTOPTIONS pPointOptions;

/* pointer to a structure that specifies various point options */

L_UINT uFlags;

/* flags that determine which objects to process */

Sets the options for the specified Automation annotation object.

Parameter

Description

pPointOptions

Pointer to an ANNPOINTOPTIONS structure that specifies various point options to set.

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 set the point options of an annotation automation object. To use this function, declare a variable a type ANNPOINTOPTIONS, and pass the address of this variable for pPointOptions. For more information, refer to the documentation for the structure ANNPOINTOPTIONS.

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.

Platforms

Win32, x64.

See Also

Functions:

Class Members

Topics:

Annotation Functions: Object Properties

 

Annotation Objects - Default Values

 

Annotation Objects - Automated Features

Example

For an example, refer to LAnnAutomation::GetPointOptions.