ErrorWithTimeout (Function)

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Characteristics of dialog box
Line break in the dialog box
Displaying the last error message
Miscellaneous

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

ErrorWithTimeout (Function)

In french: ErreurAvecDélai

Displays a custom error message in a system error window for a set amount of time. After the timeout, the system window is automatically closed.

Example

// Display "An error was detected" in an error window
// This error window will be automatically closed after 10 seconds.
ErrorWithTimeout(1000, "An error was detected")

// Display the last error in an error window
// This error window will be automatically closed after 5 seconds.
ErrorWithTimeout(500)

Syntax

Displaying a custom error message Hide the details

ErrorWithTimeout(<Timeout>, <Text> [, <Line 2> [, ... [, <Line n>]]])

<Timeout>: Integer ou Duration

Amount of time (expressed in hundredth of second) before automatically closing the error window. This parameter can correspond to:
an integer corresponding to the number of hundredths of a second,
a Duration variable,
Versions 23 and later
the direct indication of duration (1 s or 10 ms for example).
New in version 23
the direct indication of duration (1 s or 10 ms for example).
the direct indication of duration (1 s or 10 ms for example).

<Text>: Character string (with quotes)

Text to display.

<Line 2>: Optional character strings (with quotes)

Text displayed on the following lines.

<Line n>: Optional character strings (with quotes)

Text displayed on the following lines.

Displaying the error message of the last WLanguage function used Hide the details

ErrorWithTimeout(<Timeout before closing>)

<Timeout before closing>: Integer ou Duration

Amount of time (expressed in hundredth of second) before automatically closing the error window. This parameter can correspond to:
an integer corresponding to the number of hundredths of a second,
a Duration variable,
Versions 23 and later
the direct indication of duration (1 s or 10 ms for example).
New in version 23
the direct indication of duration (1 s or 10 ms for example).
the direct indication of duration (1 s or 10 ms for example).

Remarks

Characteristics of dialog box

The title of dialog box corresponds to the title of current window. To modify this title, use NextTitle.
The message is aligned to left.
The button caption depends on the runtime language of Windows.
The maximum number of characters cannot exceed 4096. If a larger string is passed in parameter, it will be truncated.
The icon displayed (white cross) cannot be modified.

To customize this dialog box (as well as all the system dialog boxes of your application), check "Apply the template theme to the system information windows" in the Style tab of the project description. See Customizing dialog boxes for more details.

Line break in the dialog box

The CR string (Carriage Return) can be used to force a break to the next line. For example:

ErrorWithTimeout(500, "An error was detected while entering the address." + CR + ...
"Modify the personal details of the customer.")

is equivalent to:

ErrorWithTimeout(500, "An error has been detected when entering the address." , ...
"Modify the personal details of the customer.")

Displaying the last error message

Using the ErrorWithTimeout function without any parameters (syntax 2) displays the error message corresponding to the last WLanguage function that triggered an error.

In this case, the following code:

ErrorWithTimeout(500)

is equivalent to:

ErrorWithTimeout(500, ErrorInfo())

Caution: ErrorWithTimeout must be used immediately after the call to the function that failed. Indeed, calling a WLanguage function may re-initialize and modify the status report of ErrorWithTimeout.

Miscellaneous

The timers (TimerSys) and the events are not stopped when this function is called.
The caption of the button is displayed in the language used by Windows on the current computer.
Equivalence: ErrorWithTimeout is equivalent to Error used with DelayBeforeClosing:
The following code:

ErrorWithTimeout(1000, "An error was detected")

is equivalent to:

DelayBeforeClosing(1000)
Error("An error was detected")

Component : wd240obj.dll