In This Topic ▼

LBitmapWindow::StatusCallBack

Summary

Override this function to update a status bar or interrupt the calling function's operation.

Syntax

#include "ltwrappr.h"

virtual L_INT LBitmapWindow::StatusCallBack (nPercentComplete)

Parameters

L_INT nPercentComplete

An integer from 0 to 100 that indicates the completion percentage of the function that uses the callback.

Returns

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

Comments

Derived classes can override this function to update a status bar or interrupt the calling function's operation.

This generalized callback function can be called by many different C++ Class Library functions. If this function returns a failure, the calling function will terminate and return the same error that the callback returned. Override this function in your derived class if you want to have control over the function in process. This function will be called only if the status callback is enabled for the class object.

LBitmapWindow overrides this function to give the user the ability to cancel an operation in progress (such as painting the bitmap while using a paint effect) by pressing the ESC key.

Required DLLs and Libraries

LTDIS
LTDLG
LTEFX
LTFIL
LTIMG
LTSCR
LTTWN
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

class LUserBitmapStatusCallBack : public LBitmapWindow   
{ 
public: 
  LUserBitmapStatusCallBack(); 
  virtual L_INT           StatusCallBack(L_INT nPercentComplete); 
  virtual ~LUserBitmapStatusCallBack(); 
 
}; 
 
////////////////////////////////////////////////////////////////////// 
// Construction/Destruction 
////////////////////////////////////////////////////////////////////// 
LUserBitmapStatusCallBack::LUserBitmapStatusCallBack() 
{ 
} 
 
LUserBitmapStatusCallBack::~LUserBitmapStatusCallBack() 
{ 
 
} 
 
L_INT LUserBitmapStatusCallBack::StatusCallBack(L_INT nPercClientRectentComplete) 
{ 
   // display a message when 30% of the status is done. 
   if(nPercClientRectentComplete == 30) 
   { 
      MessageBox(NULL, TEXT("30 Percent of AddNoise function is completed."), TEXT("StatusCallBack"), MB_OK); 
   } 
   return SUCCESS; 
}