In This Topic ▼

LAnnStamp::GetBitmap

Summary

Gets the bitmap handle of the annotation object.

Syntax

#include "ltwrappr.h"

virtual L_INT LAnnStamp::GetBitmap(pBitmap, uStructSize)

Parameters

LBitmapBase * pBitmap

Pointer to an LBitmapBase object to be updated with the handle to the annotation object's bitmap.

pBITMAPHANDLE pBitmap

Address of the variable to be updated with the handle to the annotation object's bitmap.

L_UINT uStructSize

Size of BITMAPHANDLE structure in bytes. Use the sizeof() operator to calculate this value.

Returns

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

Comments

Before calling LAnnStamp::GetBitmap(pBitmap, uStructSize), where pBitmap is of type LBitmapBase, you must declare an LBitmapBase object. Then, pass the address of the object in the pBitmap parameter. This function will update the object with the handle to the annotation object's bitmap.

Before calling LAnnStamp::GetBitmap(pBitmap, uStructSize), where pBitmap is of type pBITMAPHANDLE, you must declare a variable of data type BITMAPHANDLE. Then, pass the address of the variable in the pBitmap parameter. This function will update the variable with the handle to the annotation object's 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.

Example

This is an example for LAnnStamp::GetBitmap(pBitmap), where pBitmap is of type pBITMAPHANDLE:

L_INT LAnnStamp_GetBitmapFirstExample(LAnnStamp  * pAnnStamp, pBITMAPHANDLE pBitmap ) 
{ 
	L_INT nRet; 
 
   if (pAnnStamp && pBitmap) 
   { 
      nRet = pAnnStamp->GetBitmap(pBitmap,sizeof(BITMAPHANDLE)); 
		if(nRet != SUCCESS) 
			return nRet; 
   }    
 
	return SUCCESS; 
} 
 
//This is an example for LAnnStamp::GetBitmap(pBitmap), where pBitmap is of type LBitmapBase : 
 
L_INT LAnnStamp_GetBitmapSecondExample(LAnnStamp  * pAnnStamp, LBitmapBase  * pLBitmap ) 
{ 
   L_INT nRet; 
 
	if (pAnnStamp && pLBitmap) 
   { 
      nRet = pAnnStamp->GetBitmap(pLBitmap,sizeof(BITMAPHANDLE)); 
		if(nRet != SUCCESS) 
			return nRet; 
   }    
	return SUCCESS; 
}