PC SOFT

ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • Codes executed at closing
  • Closing according to the type of window
  • Last project window
  • First project window
  • Value returned to the Open function
  • Alt + F4 keys
  • Equivalence
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Closes a WINDEV window (and returns a value if necessary).
Versions 24 and later
Windows This function is now available for WEBDEV sites in Windows.
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
Windows This function is now available for WEBDEV sites in Windows.
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.
Windows This function is now available for WEBDEV sites in Windows.
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
Reports and QueriesWindows
// Close the "WIN_EditUsername" window
// and retrieve several return values
Close(WIN_EditUsername, LastName, FirstName)
New in version 19
Reports and QueriesWindows
// Close the "WIN_EditUsername" window
// and retrieve several return values
Close(WIN_EditUsername, LastName, FirstName)
Reports and QueriesWindows
// Close the "WIN_EditUsername" window
// and retrieve several return values
Close(WIN_EditUsername, 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.

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
Reports and QueriesWindows Value N returned by the window when it is closed (if several values are returned).

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
Reports and QueriesWindows Value N returned by the window when it is closed (if several values are returned).

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.
Reports and QueriesWindows Value N returned by the window when it is closed (if several values are returned).

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

Reports and Queries

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 the ReturnedValue property (<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
    // Users enter their password in the EDT_Password control
    // and validates the window.
    Close("", EDT_Password)
  • Versions 19 and later
    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:
    (MyUsername, MyPassword) = Open(WIN_EditPassword)
    IF MyUsername <> "" OR MyPassword <> "" THEN
    Info("Wrong username or password")
    END
     
    // -- Click code on "OK" button in the "WIN_EditPassword" window
    // Users enter their username and password
    // in the EDT_Password control and validates the window.
    Close("", EDT_Username, EDT_Password)
    New in version 19
    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:
    (MyUsername, MyPassword) = Open(WIN_EditPassword)
    IF MyUsername <> "" OR MyPassword <> "" THEN
    Info("Wrong username or password")
    END
     
    // -- Click code on "OK" button in the "WIN_EditPassword" window
    // Users enter their username and password
    // in the EDT_Password control and validates the window.
    Close("", EDT_Username, EDT_Password)
    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:
    (MyUsername, MyPassword) = Open(WIN_EditPassword)
    IF MyUsername <> "" OR MyPassword <> "" THEN
    Info("Wrong username or password")
    END
     
    // -- Click code on "OK" button in the "WIN_EditPassword" window
    // Users enter their username and password
    // in the EDT_Password control and validates the window.
    Close("", EDT_Username, EDT_Password)

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
See also
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment