BE_DialogProgressUpdate

BE_DialogProgressUpdate ( number {; description } )

Used to either close a progress dialog, or advance a progress dialog to the next step.

Version : 2.1
4.0 : return error 3, command not available on iOS, Linux and under FMS
4.0.2 : Renamed from BE_ProgressDialog_Update

Parameters :

• number : the progress number.
• description : any updates to the text that is to appear in the dialog.

Result : no result. However, the BE_GetLastError will return 0 for a successful update and 1 when the user has clicked the Cancel button in a progress dialog.

Examples :

BE_DialogProgressUpdate ( 1 ; "description" ) //Closes a barber pole dialog

BE_DialogProgressUpdate ( $nextValue ; "description" ) //Move the progress dialog, along to the next value, while updating the description text.

BE_DialogProgressUpdate ( 10 ) //Close a progress dialog that started with maxiumum 9, and had 10 steps ( 0 through 9 )`