Close (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Controls, pages and windows / Window functions

Codes executed at closing
Closing according to the type of window
Last project window
Value returned to the Open function
Alt + F4 keys
Equivalence

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Close (Function)

In french: Ferme

Closes a WINDEV window (and returns a value if necessary).

This function is available only to simplify the Webification of WINDEV projects. In a WEBDEV website, this function has the same behavior as PageCloseDialog or ContextClose, according to each case.

Example

// Fermeture de la fenêtre "FEN_Saisie" 
Close(FEN_Saisie)

// Fermeture de la fenêtre "FEN_SaisieLogin" 
// avec récupération de plusieurs valeurs de retour
Close(FEN_SaisieLogin, Nom, Prénom)

Syntax

Close([<Window> [, <Returned value> [... [, <Returned value N>]]]])

<Window>: Optional window name

Name of window to close. If this parameter is not specified or is an empty string (""), the current window is closed.

<Returned value>: Type corresponding to the returned value (optional)

Value returned by the window when it is closed.
This value is retrieved only if the window was opened by Open.

You have the ability to return:
simple types (character string, boolean, ...).
advanced types: structure, dynamic structure, class, advanced type, array, associative array, queue, stack, list.

<Returned value N>: Type corresponding to the returned value (optional)

Value N returned by the window when it is closed (if several values are returned).
This value is retrieved only if the window was opened by Open.

You have the ability to return:
simple types (character string, boolean, ...).
advanced types: structure, dynamic structure, class, advanced type, array, associative array, queue, stack, list.

Remarks

Codes executed at closing

When closing a window:
1. The current process is permanently interrupted.
2. The "Close" event of the window is executed.
If SetFocusAndReturnToUserInput is called in the "Close" event, the window is not closed.
If Close is run in a procedure called by Timer, WinStatus or CurrentWin must be used to confirm the existence of the window to close, otherwise all open windows may be closed. For example:
```
// Procédure appelée par timer
Fenêtre is string 
Fenêtre = CurrentWin()
IF Fenêtre <> "Nom fenêtre" THEN
	Close()
END
```

Closing according to the type of window

If the window to close is a parent window with child windows, these child windows will be closed first (their closing code is run).
If the window to close is a child window, the parent window becomes the current window. The "gain of focus" code of parent window is run.

Last project window

If the last window is closed, the "Close" event of the project is executed before the end of the program.

Value returned to the Open function

Close can be used to return one or more values to Open.

Reminder: It is also possible to return a value using the property ReturnedValue (<Window Name>.ReturnedValue) executed before the function Close. In this case, a single value can be returned.

Examples:

The user must type a password in a window. This password is retrieved when this window is closed and it is returned to Open:

MonMotDePasse = Open(FEN_SaisieMotDePasse)
IF MonMotDePasse <> "" THEN
	Info("Mot de passe incorrect") 
END

// -- Code de clic sur le bouton "OK" de la fenêtre "FEN_SaisieMotDePasse"
// L'utilisateur saisit son mot de passe dans le champ SAI_MotDePasse 
// et valide la fenêtre.
Close("", SAI_MotDePasse)

The user must enter a username and a password in a window. The username and password are retrieved when the window is closed and returned to Open:

(MonLogin, MonMotDePasse) = Open(FEN_SaisieMotDePasse)
IF MonLogin <> "" OR MonMotDePasse <> "" THEN 
	Info("Login ou mot de passe incorrect")
END

// -- Code de clic sur le bouton "OK" de la fenêtre "FEN_SaisieMotDePasse"
// L'utilisateur saisit son login et son mot de passe 
// dans le champ SAI_MotDePasse et valide la fenêtre.
Close("", SAI_Login, SAI_MotDePasse)

Alt + F4 keys

Pressing Alt + F4 can trigger several behaviors:

If the window contains an "Abandon" button, the WLanguage event associated with the abandon button is executed.
If the window has a button with Alt + F4 as keyboard shortcut, the WLanguage event associated with this button is executed.
If the window does not contain an "abandon" button, or a button with Alt + F4 as keyboard shortcut, the closing process of the window is executed and the window is closed (except if SetFocusAndReturnToUserInput is called).
If a window is opened from a program in external language, Alt + F4 returns "ESC" in WdKey.

Equivalence

The following line of code:

WinStatus(<Window>, NotFound)

is equivalent to:

Close(<Window>)

Component: wd300obj.dll