C++ SDK

◆ FlashMessage()

static int CApplicationAPI::FlashMessage ( LpError  lpError,
LPCTSTR  lpszMessage,
BOOL  bShowApplication,
DWORD  dwMaxTime = DEFAULT_MAX_TIME 
)
static

The function shows flash message.

Parameters
lpErrorAdditional error information returned from Drive.
lpszMessageText of the message to be shown.
dwMaxTimeMaximum time (in milliseconds) function can take. If dwMaxTime=0 function execution is not time limited.
bShowApplicationFlag determining whether Drive should be brought to foreground automatically.
true - Drive will be brought to foreground
false - Drive will stay in background
Returns
1 if successful, other value otherwise.

FlashMessage shows flashing message with taken text in top-right corner.

Possible error codes returned from Drive are:

  • 0 - Function not succeeded.
  • 1 - Function succeeded.
  • 2 - Drive not succeeded.
  • 3 - Function reached timeout.