C++ Syntax

bool

MKI_DialogShowProgress(

const LPCWSTR f_pszTitle,

const LPCWSTR f_pszText,

bool f_fHasPercentBar );

Displays a non-modal progress indication dialog box and disables the application's window.

The middle and lower line of the progress indicator will be initialized with an empty text, the percent bar (if existing) will be initialized with 0%.

Each time MKI_DialogShowProgress is called, a counter starting with 0 will be increased. Each time MKI_DialogHideProgress is called, that counter will be decreased. Once the counter is at least 1, the dialog will be visible.

Parameters

Title

[const LPCWSTR] Title of the dialog window to be displayed. Be careful that the given title fits into the dialog window's caption.

Text

[const LPCWSTR] Text to be displayed in the upper line of the progress indicator. The text may contain one linefeed. This text should be used to describe the current action, like "Importing from file\nXYZ". When using file names here, be sure to display only the file's base name and not the complete path. You can use MKI_FileSplitName to retrieve a file's base name.

HasPercentBar

[bool] If HasPercentBar is true, the progress indicator will be equipped with a percent bar.

Return Value

Returns true if successful, or false if unable to display the progress indicator (due to memory limitations).