# CreateProgressDialog

int CreateProgressDialog (const char title[], const char progressIndicatorLabel[], int dialogIsModal, int indicatorMarkerStyle, const char cancelButtonLabel[]);

## Purpose

This function creates and displays a dialog which can be used to indicate the completion status of a lengthy operation.

## Parameters

Input
Name | Type | Description
title | const char [] | Specifies the title of the progress dialog.
progressIndicatorLabel | const char [] | This parameter specifies the label for the horizontal progress bar that appears on the progress dialog. Pass "" if you do not want a label.
dialogIsModal | integer | This parameter specifies whether the progress dialog is modal or non–modal.
indicatorMarkerStyle | integer | This control specifies how to mark the percentage values on the horizontal progress bar.
cancelButtonLabel | const char [] | This parameter specifies the label for the dialog's cancel button. The shortcut key for the cancel button is automatically set to be the ESC key. Pass "" if you want the cancel button to be invisible. Pass 0 if you do not want a cancel button. If the dialog does not have a cancel button, then it will not detect if the user has pressed the ESC key. The UpdateProgressDialog function returns whether the user has requested to stop the operation by pressing the cancel button or the ESC key.

## Return Value

Name | Type | Description
progressDialog | integer | This control returns a positive integer panel handle which can be used to refer to the progress dialog in subsequent calls to UpdateProgressDialog or DiscardProgressDialog. If an error occurred while creating the dialog, a negative User Interface Library error code is returned.