Sfairadora

  • Reference Guide

cancel_window

cancel_window()
cancel_window(error_message)
The function is designed to be used within a definition of the window content displayed by the functions ask or edit. It is typically used in a cancel button. The cancel_window function closes the window, while the function that has opened it (ask or edit) returns an error. If the error_message parameter (of the type String) is specified, it contains a message to be associated with the resulting error.
The variant without a parameter can be also used to close other windows, for instance a window opened by a disp-folder. In that case, the changes made in the edited data are discarded, as if the window were closed by the Esc key.

Return Value

At success, the function returns the value NONE. If the function is not called from within a window, or the function variant with a parameter is invoked from within another window than a window opened with the functions ask or edit, an error is returned.

See Also