L_AnnSetRotateOptions

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetRotateOptions(hObject, pRotateOptions, uFlags)

HANNOBJECT hObject;

/* handle to the annotation object */

pANNROTATEOPTIONS pRotateOptions;

/* pointer to the ANNROTATEOPTIONS structure */

L_UINT uFlags;

/* flags that indicate which objects to process */

Sets the rotation options for the annotation object. This function is available in Document and Medical Imaging toolkits.

Parameter

Description

hObject

Handle to the annotation object.

pRotateOptions

Pointer to an ANNROTATEOPTIONS structure that specifies the rotate options to set.

uFlags

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

 

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 L_AnnGetSelected and L_AnnSetSelected 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 sub containers, 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 rotate options of any annotation object, including the automation object. To use this function, declare a variable of type ANNROTATEOPTIONS, and pass the address of this variable for pRotateOptions. For more information, refer to the documentation for the structure ANNROTATEOPTIONS.

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

Windows 2000 / XP/Vista.

See Also

Functions:

L_AnnGetRotateOptions, L_AnnCalibrateRuler, L_AnnCalibrateRulerSuccessive

Topics:

Annotation Functions: Getting and Setting the Rotation Options

 

Altering Annotation Object Settings

Example

For an example, refer to L_AnnGetRotateOptions.