LAnnPoint::GetPointOptions

#include "ltwrappr.h"

virtual L_INT LAnnPoint::GetPointOptions(pPointOptions, uStructSize)

pANNPOINTOPTIONS pPointOptions;	/* pointer to a structure that specifies various point options */
L_UINT uStructSize;	/* size in bytes, of the structure pointed to by pPointOptions */

Gets the options for the specified point annotation object.

Parameter	Description
pPointOptions	Pointer to an ANNPOINTOPTIONS structure to be updated with the various point appearance options for the specified annotation object.
uStructSize	Size in bytes, of the structure pointed to by pPointOptions. Use sizeof(ANNPOINTOPTIONS).

Returns

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

Comments

Use this function to get the point appearance options of an annotation point object. To use this function, declare a variable of type ANNPOINTOPTIONS, and pass the address of this variable as the second argument. For more information, see 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

// This example toggles the appearance of a point annotation object.

// The appearance toggles between bitmap and circle.

L_INT LAnnPoint_GetPointOptionsExample(LAnnPoint *pLPoint) 
{
	L_INT nRet;
   HMETAFILE hMetafile1=0; 
   HMETAFILE hMetafile2=0; 
   ANNPOINTOPTIONS PointOptions; 
   L_UINT uObjectType; 
   
   UNREFERENCED_PARAMETER(hMetafile1);
	UNREFERENCED_PARAMETER(hMetafile2);
	uObjectType = pLPoint->GetType ();
   if (uObjectType != ANNOBJECT_POINT) 
   {
		
      MessageBox(NULL, TEXT("This object is not a point object."), TEXT("Error"), MB_OK); 
      return FAILURE ; 
   }
   memset(&PointOptions, 0, sizeof(ANNPOINTOPTIONS)); 
   PointOptions.uStructSize = sizeof(ANNPOINTOPTIONS); 
   PointOptions.uFlags = ANNPOINT_ALL; 
   pLPoint->GetPointOptions(&PointOptions, sizeof(PointOptions)); 
   if (PointOptions.bPointUseBitmap) 
   {
      // Change point appearance to a circle
      PointOptions.uStructSize = sizeof(ANNPOINTOPTIONS); 
      PointOptions.bPointUseBitmap = FALSE; 
      PointOptions.bPointFixedSize = FALSE; 
      PointOptions.bPointTransparentFill = FALSE; 
      PointOptions.crPointBorderColor = RGB(0,0,0); 
      PointOptions.crPointFillColor   = RGB(255, 255, 0); 
      PointOptions.nPointRadius = 12; 
      PointOptions.nReserved = 0; 
      PointOptions.uFlags =   ANNPOINT_USE_BITMAP        | 
                              ANNPOINT_RADIUS            | 
                              ANNPOINT_BORDER_COLOR      |
                              ANNPOINT_FILL_COLOR        |
                              ANNPOINT_TRANSPARENT_FILL  |
                              ANNPOINT_FIXED_SIZE; 
   }
   else
   {
      // Change point appearance to a bitmap
      PointOptions.uStructSize = sizeof(ANNPOINTOPTIONS); 
      PointOptions.bPointUseBitmap = TRUE; 
      PointOptions.bPointBitmapTransparent = TRUE; 
      PointOptions.crPointBitmapTransparentColor = RGB(255,255,255); 
      PointOptions.nReserved = 0; 
   }
   nRet = pLPoint->SetPointOptions(&PointOptions, 0); 
	if(nRet != SUCCESS)
		return nRet;
	return SUCCESS;
}