ErrorBuild (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Standard functions / Windows management functions / Dialog Box functions

Features of the dialog box
Miscellaneous
Emulation
Application in the background: Specific case from Android 10

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

ErrorBuild (Function)

In french: ErreurConstruit

Displays a custom error message in a system error window.To close the window, the user must click OK.

WINDEV allows you to apply the skin template of your project to this dialog box. For more details, see Customizing dialog boxes.

In a Webservice, ErrorBuild is used to define the error returned by the Webservice. If ErrorBuild is called multiple times, the error messages are concatenated.

Example

NextTitle("Error: Unknown customer")
ErrorBuild("The %1 code does not exist. It must be created.", cCustomerCode)

Syntax

ErrorBuild(<Format string> [, <Parameter 1> [... [, <Parameter N>]]])

<Format string>: Character string

Character string to display containing optional parameters (%1 to %n). To display the % character, this character must be typed twice (%%).

<Parameter 1>: Optional character string

First parameter that will be inserted into the formatted character string.
<Parameter 1> will replace the %1 character, <Parameter 2> will replace the %2 character, etc.
The number of specified parameters must be equal to or greater than the number of parameters used in <Format string>.
If <Format string> contains more parameters, the additional parameters will be replaced with empty strings.

<Parameter N>: Optional character string

Nth parameter that will be inserted into the formatted character string.
<Parameter 1> will replace the %1 character, <Parameter 2> will replace the %2 character, etc.
The number of specified parameters must be equal to or greater than the number of parameters used in <Format string>.
If <Format string> contains more parameters, the additional parameters will be replaced with empty strings.

Remarks

Features of the dialog box

The title of the dialog box corresponds to the title of the current window (or page).
To comply with the system specifications, the title of dialog box is empty by default. To define this title, use NextTitle.
To modify or define the title of dialog box, use NextTitle.

The message is aligned to the 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 as parameter, it will be truncated.
The icon displayed (white cross) cannot be modified.

To customize this dialog box (and all the system dialog boxes in your application), check "Customize system windows (Info, YesNo, Confirm, Dialog)" in the "Style" tab of the project description. For more details, see Customizing dialog boxes.

To customize this dialog box (and all the system dialog boxes in your site), check "Apply the skin to the dialog boxes (YesNo and OKCancel)" in the "Skin" tab of the project description window.

Miscellaneous

Timers (TimerSys) are not stopped when this function is called.
Windows events are not stopped when this function is called.
You can use the code wizard to enter the function in the code editor. Depending on the characteristics entered in the wizard, the function used can be different in the code that is automatically generated.
DelayBeforeClosing limits how long the message is displayed. The dialog box is automatically closed. For question or confirmation dialog boxes, the default button corresponds to the expected answer.
The caption of the button is displayed in the language used by Windows on the current computer.
This function must not be used:
- in the "Resizing" event of the window. Otherwise, the application will be locked.
- in the "Changing the orientation" event of the window.
- in the "Move to the foreground" event associated with the project.
  Remark: However, the function can be used in the "Move to the foreground" event of a window.
- in a thread.

Emulation

An error message can be emulated by EmulateError.

Application in the background: Specific case from Android 10

From Android 10, it is no longer possible to open a window when the application is in the background.

ErrorBuild can open a window. If this function is used while the application is in the background, a fatal error will occur.

Tips:

It is possible to determine if the application is in the background using InBackgroundMode.
If an application needs to interact with the user while it is in the background, the solution is to display a notification (via the Notification type). The application will be brought back to the foreground when the notification is clicked, if the ActivateApplication property is set to True. You can also open a window from the procedure passed to the ActionClick property.

For more details, see Android 10: Behavior of applications in the background.

Component: wd280obj.dll