Close (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Window management functions

Presentation

Example

Codes executed at closing

Closing according to the type of window

Last project window

First project window

Value returned to the Open function

Value returned when closing a child window

Alt + F4 keys

Equivalence

See also

Close (Function)

In french: Ferme

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

Versions 16 and later

This function is now available for WINDEV applications in Linux.

This function is now available for Windows Phone applications.

New in version 16

This function is now available for WINDEV applications in Linux.

This function is now available for Windows Phone applications.

This function is now available for WINDEV applications in Linux.

This function is now available for Windows Phone applications.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Versions 24 and later

This function is now available for WEBDEV sites in Linux.

This function is now available for WEBDEV sites in Windows.

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

New in version 24

This function is now available for WEBDEV sites in Linux.

This function is now available for WEBDEV sites in Windows.

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

This function is now available for WEBDEV sites in Linux.

This function is now available for WEBDEV sites in Windows.

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

Example

// Close the "WIN_Edit" window
Close(WIN_Edit)

Versions 19 and later

// Close the "WIN_EditLogin" window
// and retrieve several return values
Close(WIN_EditLogin, LastName, FirstName)

New in version 19

// Close the "WIN_EditLogin" window
// and retrieve several return values
Close(WIN_EditLogin, LastName, FirstName)

Syntax

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

<Window>: Optional window name

Name of window to close. If this parameter is not specified or if it corresponds to 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.

This value is retrieved only if the window was opened by OpenMobileWindow (or by OpenChild).
You have the ability to return:
simple types (character string, boolean, ...).
Versions 15 and later
advanced types: structure, dynamic structure, class, advanced type, array, associative array, queue, stack, list.
New in version 15
advanced types: structure, dynamic structure, class, advanced type, array, associative array, queue, stack, list.
advanced types: structure, dynamic structure, class, advanced type, array, associative array, queue, stack, list.

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

Versions 19 and later
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.
New in version 19
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.
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 "Closing" window event is run.
If SetFocusAndReturnToUserInput is called in the "Closing" 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:

// Procedure called by timer
Window is string
Window = CurrentWin()
IF Window <> "Window name" 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 project window is closed, the "Closing" project event is run before the end of the program.

First project window

Value returned to the Open function

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

Reminder: A value can also be returned by ReturnedValue (<Window name>..ReturnedValue) run before 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:

MyPassword = Open(WIN_EditPassword)
IF MyPassword <> "" THEN
Info("Wrong password")
END

// -- Click code on "OK" button in the "WIN_EditPassword" window
// The user types his password in the EDT_Password control
// and validates the window.
Close("", EDT_Password)
Versions 19 and later
The user must type a login and a password in a window. The login and password are retrieved when closing this window and they are returned to Open:

(MyLogin, MyPassword) = Open(WIN_EditPassword)
IF MyLogin <> "" OR MyPassword <> "" THEN
Info("Wrong login or password")
END

// -- Click code on "OK" button in the "WIN_EditPassword" window
// The user types his login and password
// in the EDT_Password control and validates the window.
Close("", EDT_Login, EDT_Password)

New in version 19
The user must type a login and a password in a window. The login and password are retrieved when closing this window and they are returned to Open:

(MyLogin, MyPassword) = Open(WIN_EditPassword)
IF MyLogin <> "" OR MyPassword <> "" THEN
Info("Wrong login or password")
END

// -- Click code on "OK" button in the "WIN_EditPassword" window
// The user types his login and password
// in the EDT_Password control and validates the window.
Close("", EDT_Login, EDT_Password)

The user must type a login and a password in a window. The login and password are retrieved when closing this window and they are returned to Open:

(MyLogin, MyPassword) = Open(WIN_EditPassword)
IF MyLogin <> "" OR MyPassword <> "" THEN
Info("Wrong login or password")
END

// -- Click code on "OK" button in the "WIN_EditPassword" window
// The user types his login and password
// in the EDT_Password control and validates the window.
Close("", EDT_Login, EDT_Password)

Versions 18 and later

Value returned when closing a child window

Close is used to return a value to the parent window that opened the child window.

Reminder: A value can also be returned by ReturnedValue (<Window name>..ReturnedValue) run before Close.

The value returned by the child window can be read in the event "Closing of a child window" of the window that opened the child window (the one that called OpenMobileWindow or OpenChild): all you have to do is use ReturnedValue on the MyChildWindow keyword.

For example:

In the closing code of the child window, Close is used to return a parameter:

Close("", MyParameter)
The name of the child window as well as the returned value can be retrieved in the event "Closing a child window" of the calling window, using the MyChildWindow keyword:

// Close a child window
NameChildWindow = MyChildWindow.Name
ValueChildWindow = MyChildWindow.ReturnedValue

New in version 18

Value returned when closing a child window

Close is used to return a value to the parent window that opened the child window.

Reminder: A value can also be returned by ReturnedValue (<Window name>..ReturnedValue) run before Close.

For example:

In the closing code of the child window, Close is used to return a parameter:

Close("", MyParameter)
The name of the child window as well as the returned value can be retrieved in the event "Closing a child window" of the calling window, using the MyChildWindow keyword:

// Close a child window
NameChildWindow = MyChildWindow.Name
ValueChildWindow = MyChildWindow.ReturnedValue

Value returned when closing a child window

Close is used to return a value to the parent window that opened the child window.

Reminder: A value can also be returned by ReturnedValue (<Window name>..ReturnedValue) run before Close.

For example:

In the closing code of the child window, Close is used to return a parameter:

Close("", MyParameter)
The name of the child window as well as the returned value can be retrieved in the event "Closing a child window" of the calling window, using the MyChildWindow keyword:

// Close a child window
NameChildWindow = MyChildWindow.Name
ValueChildWindow = MyChildWindow.ReturnedValue

Alt + F4 keys

Pressing Alt + F4 can trigger several behaviors:

If the window contains an "Abandon" button, the process associated with the abandon button is run.
If the window contains a button whose shortcut is Alt + F4, the process associated with this button is run.
If the window contains no abandon button and no button whose shortcut is Alt + F4, the closing process of window is run 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(<WindowName>, NotFound)

is equivalent to:

Close(<WindowName>)

Component: wd270obj.dll