LAnnStamp::GetBitmap

#include "ltwrappr.h"

virtual L_INT LAnnStamp::GetBitmap(pBitmap, uStructSize)

LBitmapBase * pBitmap;	/* pointer to an LBitmapBase object */
pBITMAPHANDLE pBitmap;	/* address of the variable to be updated */
L_UINT uStructSize;	/* size of the structure */

Gets the bitmap handle of the annotation object.

Parameter	Description
pBitmap	Pointer to an LBitmapBase object to be updated with the handle to the annotation object's bitmap.
pBitmap	Address of the variable to be updated with the handle to the annotation object's bitmap.
uStructSize	Size of BITMAPHANDLE structure in bytes. Use the sizeof() macro to calculate this value.

Returns

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 aan 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.

See Also

Functions:	LAnnStamp::SetBitmap, Class Members
Topics:	Annotation Functions: Object Properties
	Using Annotation Bitmap Objects

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;
}