L_AnnGetTextPointerFixed

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetTextPointerFixed(hObject, pbPointerFixed)

HANNOBJECT hObject;	/* handle to the annotation object */
L_BOOL *pbPointerFixed;	/* pointer to a variable to be updated */

Gets a value that indicates whether the pointer of an ANNOBJECT_TEXTPOINTER object is fixed.

This function is available in the Document and Medical Imaging toolkits.

Parameter	Description
hObject	Handle to the annotation object.
pbPointerFixed	Pointer to a variable to be updated with a value that specifies whether the pointer of an ANNOBJECT_TEXTPOINTER is fixed. Possible values are:
	Value	Meaning
	TRUE	The pointer of the ANNOBJECT_TEXTPOINTER object is fixed.
	FALSE	The pointer of the ANNOBJECT_TEXTPOINTER moves with the object.

Returns

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

Comments

The function is valid only for the ANNOBJECT_TEXTPOINTER annotation object.

If pbPointerFixed is updated with TRUE, the text pointer of the object is fixed. When the text pointer is fixed, the location that the text pointer points to does not change when moving the object (either programatically or through automation).

If pbPointerFixed is updated with FALSE, the text pointer of the object is not fixed. This means that when the object is moved, the location the text pointer points to moves along with the object.

Calling this function on an object other the ANNOBJECT_TEXTPOINTER will return ERROR_FEATURE_NOT_SUPPORTED.

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_AnnSetTextPointerFixed, L_AnnGetTextFixedSize, L_AnnSetTextFixedSize
Topics:	Annotation Functions: Object Properties
	Annotation Objects - Default Values
	Annotation Objects - Automated Features
	Implementing an Automated Annotation Program
	Implementing a Non-automated Annotation Program
	Obtaining Annotation Object Information

Example

Sample for L_AnnGetTextPointerFixed, L_AnnSetTextPointerFixed. This Example toggles the text pointer fixed state of an ANNOBJECT_TEXTPOINTER.

 L_INT AnnGetTextPointerFixedExample(HANNOBJECT hObject)
{
   L_INT nRet;
   L_BOOL   bTextPointerFixed;
   L_TCHAR  szMsg[100];
   L_UINT   uType;

   L_AnnGetTextPointerFixed(hObject, &bTextPointerFixed);

   bTextPointerFixed = !bTextPointerFixed;

   nRet= L_AnnSetTextPointerFixed(hObject, bTextPointerFixed, 0);
   if (nRet != SUCCESS)
   {
      L_AnnGetType(hObject, &uType);
      wsprintf(szMsg, TEXT("L_AnnSetTextPointerFixed Error: %d on object type[%d]\n"), nRet, uType);
      MessageBox(NULL, szMsg, TEXT("Error"), MB_OK);
      return nRet;
   }
   return SUCCESS;
}