L_AnnGetPredefinedBitmap

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetPredefinedBitmap(uType, pBitmap, uStructSize)

L_UINT uType;

constant that indicates the bitmap to retrieve

pBITMAPHANDLE pBitmap;

pointer to a variable to be updated with the bitmap handle

L_UINT uStructSize;

size of the BITMAPHANDLE structure

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.
uStructSize Size in bytes, of the structure pointed to by pBitmap, for versioning. Use sizeof(BITMAPHANDLE).

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function is valid only for the ANNOBJECT_POINT object. You must free the bitmap handle when you are finished, using L_FreeBitmap. Call the L_AnnSetPredefinedBitmap 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.

Platforms

Win32, x64.

See Also

Functions:

L_AnnGetMetafile, L_AnnSetMetafile, L_AnnGetPredefinedMetafile, L_ScrambleBitmap, L_AnnEncryptApply, L_AnnSetEncryptOptions, L_AnnGetEncryptOptions

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

 

Annotation Functions (Document/Medical only): Getting and Setting the Object Bitmap Property

Example

This example does the following:

1. Gets the current point bitmap.
2. Inverts it.
3. Sets the inverted bitmap to be the default point bitmap.

L_INT AnnGetPredefinedBitmapExample() 
{ 
   BITMAPHANDLE PointBitmap; 
   L_INT nRet = SUCCESS; 
   // Get predefined point bitmap 
   nRet = L_AnnGetPredefinedBitmap(ANNBITMAP_POINT, &PointBitmap, sizeof(BITMAPHANDLE)); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   // Invert it 
   nRet = L_InvertBitmap(&PointBitmap, 0); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   // Set as new point bitmap 
   nRet = L_AnnSetPredefinedBitmap(ANNBITMAP_POINT, &PointBitmap); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   // Free the bitmap 
   L_FreeBitmap(&PointBitmap); 
 
   MessageBox(NULL, TEXT("Now create a point annotation object.  The bitmap is inverted"), TEXT(""), MB_OK); 
   return SUCCESS; 
} 

Help Version 20.0.2018.2.25
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Raster Imaging C API Help