GuiDestroyWindow()

Destroys a window (and all of its controls, and child windows).


Synopsis

error = GuiDestroyWindow(Options)


Args

Options can be any, all, or none of the following, each separated by a | character:

Options Meaning
VARS Updates all the REXX variables associated with the controls in the window.
PLACEMENT Updates the REXX variables GuiX, GuiY, GuiWidth, and GuiHeight.

If Options is omitted, then it defaults to none of the above.


Returns

If successful, an empty string is returned. If an error, an error message.


Notes

This must be called by a Window Layout script. It is typically called in the layout script's Destroy function if it is desired to destroy the window when the main script DROPs the object variable referencing that Window Layout script.

It is not considered an error to call GuiDestroyWindow if a Window Layout script's call to GuiCreateWindow failed.