L_AnnGetPredefinedBitmap

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetPredefinedBitmap(uType, pBitmap, uStructSize)

Retrieves a copy of the specified predefined bitmap.

Parameters

L_UINT uType

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

Value Meaning
ANNBITMAP_POINT [0] Predefined metafile for annotation point object

pBITMAPHANDLE pBitmap

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

L_UINT uStructSize

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

Returns

Value Meaning
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

Platforms

Win32, x64.

See Also

Functions

Topics

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 21.0.2021.4.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help