LAnnRedact::Unrealize

#include "ltwrappr.h"

virtual L_INT LAnnRedact::Unrealize(pBitmap, prcBounds)

LBitmapBase * pBitmap;	/* pointer to the LBitmapBase object */
pBITMAPHANDLE pBitmap;	/* pointer to the bitmap handle */
LPRECT prcBounds;	/* pointer to the Windows RECT structure */

Restores Redact annotation objects that have a bitmap saved inside them.

Parameter	Description
pBitmap	Pointer to the bitmap object referencing the bitmap to update.
pBitmap	Pointer to the bitmap handle 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

Restores the background of a redact object.

If you realize a redact object, moving the redact object will leave the original location of the redact object hidden. When you call LAnnContainer::Realize and specify RedactOnly, for every Redact object, the background of the image behind is saved inside the object. To restore the image under the redact object (so that when you move the redact object, the underlying image is not hidden), you must unrealize the redact object by calling LAnnContainer::Unrealize. LAnnContainer::Unrealize will restore the background from a redact object that contains a background bitmap. The background of a locked object cannot be restored until the object is unlocked. bSelected indicates whether all the Redact objects included in the container should be restored, or if only selected objects should be restored. Locked redact objects are not restored. The background bitmap stored inside the redact object is destroyed after being restored.

The return value is SUCCESS if all objects have been restored, ERROR_ANN_LOCKED if one or more redact objects are not restored because they are still locked. Any other error code is an indication of a fatal error.

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:	Class Members
Topics:	Annotation FunctionsRealizing to a Bitmap
	Displaying and Manipulating Annotation Objects

Example

This is an example for LAnnRedact::Unrealize(pBitmap, prcBounds):

L_INT LAnnRedact_UnrealizeFirstExample(pBITMAPHANDLE pLeadBitmap,LAnnRedact  * pLeadRedact)
{
	L_INT nRet;
   // unrealize all of the redact objects 
	nRet = pLeadRedact->Unrealize(pLeadBitmap, NULL); 
   if(nRet == ERROR_ANN_LOCKED)
      MessageBox(NULL, TEXT("Some redact objects are locked and cannot be restored"), TEXT("Warning"), MB_OK);
	
	return nRet;
}
//This is an example for LAnnRedact::Unrealize(pBitmap, prcBounds):
L_INT UnrealizeSecondExample(LBitmapBase  * pLeadBitmap,LAnnRedact  * pLeadRedact)
{
	L_INT nRet;
   // unrealize all of the redact objects 
	nRet = pLeadRedact->Unrealize(pLeadBitmap, NULL); 
   if(nRet == ERROR_ANN_LOCKED)
      MessageBox(NULL, TEXT("Some redact objects are locked and cannot be restored"), TEXT("Warning"), MB_OK);
	
	return nRet;
}