LAnnPoint::GetPredefinedBitmap

#include "ltwrappr.h"

static L_INT LAnnPoint::GetPredefinedBitmap(uType, pBitmap, uStructSize)

static L_INT LAnnPoint::GetPredefinedBitmap(uType, pLBitmap, uStructSize)

L_UINT uType;

/* constant that indicates the bitmap to retrieve */

pBITMAPHANDLE pBitmap;

/* pointer to a variable to be updated with the bitmap handle */

pLBitmapBase *pLBitmap;

/* pointer to an object to be updated with the bitmap handle */

L_UINT uStructSize;

/* size in bytes, of the structure pointed to by pBitmap or pLBitmap */

Retrieves a copy of the specified predefined bitmap.

Parameter

Description

uType

Value that indicates the bitmap to retrieve.  Possible values are:

 

Value

Meaning

 

ANNBITMAP_POINT

[0] Predefined metafile for annotation point object

pBitmap

Pointer to a variable to be updated with the bitmap handle.

pLBitmap

Pointer to a valid bitmap object containing the image to set.

uStructSize

Size in bytes, of the structure pointed to by pBitmap or pLBitmap.. Use sizeof(BITMAPHANDLE).

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

You must free the bitmap handle when you are finished, using the LBitmapBase::Free function. Call the LAnnPoint::SetPredefinedBitmap function to change or reset the predefined bitmap.

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:

LAnnPoint::GetPredefinedBitmap

Topics:

Annotation Functions: Object Properties

 

Annotation Objects - Default Values

 

Annotation Objects - Automated Features

 

Using Annotation Bitmap Objects

Example

// This example does the following:

// 1. Gets the current point bitmap

// 2. Inverts it

// 3. Sets the inverted bitmap as the default point bitmap

L_INT LAnnPoint_GetPredefinedBitmapExample()
{
	L_INT nRet;
   LBitmap PointBitmap; 
   // Get predefined point bitmap
   nRet = LAnnPoint::GetPredefinedBitmap(ANNBITMAP_POINT, &PointBitmap, sizeof(BITMAPHANDLE)); 
	if(nRet != SUCCESS)
		return nRet;
   // Invert it
   nRet = PointBitmap.Invert();
	if(nRet != SUCCESS)
		return nRet;
   // Set as new point bitmap
   nRet = LAnnPoint::SetPredefinedBitmap (ANNBITMAP_POINT, &PointBitmap); 
	if(nRet != SUCCESS)
		return nRet;
   MessageBox(NULL, TEXT("Now create a point annotation object.  The bitmap is inverted"), TEXT(""), MB_OK); 
	
	return SUCCESS;
}