LAnnotation::Realize
#include "ltwrappr.h"
virtual L_INT LAnnotation::Realize(pBitmap, prcBounds)
virtual L_INT LAnnotation::Realize(pLBitmap, prcBounds)
pBITMAPHANDLE pBitmap; |
/* pointer to the bitmap handle */ |
LBitmapBase * pLBitmap; |
/* pointer to an LBitmapBase object */ |
LPRECT prcBounds; |
/* pointer to the Windows RECT structure */ |
Applies the annotation object to a bitmap, altering the bitmap, itself.
Parameter |
Description |
pBitmap |
Pointer to the bitmap handle referencing the bitmap to update. |
pLBitmap |
Pointer to the LBitmapBase object referencing the bitmap to update. |
prcBounds |
Pointer to the Windows RECT structure that specifies the bounding rectangle where the annotations will be drawn. You can pass NULL for the default, which matches the bitmap by specifying left = 0, top = 0, right = bitmap width, and bottom = bitmap height. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Encryptor objects cannot be realized. The encryptor is the only annotation object that cannot be realized.
This function works only for 1, 4, 8, 16, and 24-bit images. When using an image that has some other number of bits per pixel, call LBitmapBase::ColorRes to change the image to a supported bits per pixel before calling LAnnotation::Realize.
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: |
|
Topics: |
|
|
Example
This is an example for LAnnotation::Realize(pBitmap, prcBounds):
L_INT LAnnotation_RealizeExample(LAnnotation& LeadAnn,pBITMAPHANDLE pBitmap) { L_INT nRet; nRet = LeadAnn.Realize(pBitmap,NULL); if(nRet != SUCCESS) return nRet; //… return SUCCESS; }