View source for API:DestroyWindow

{{LuaApi|group=Interface}}
Destroys a window and all of its children.

<pre>
DestroyWindow(windowName)
</pre>

== Arguments ==
;windowName : <code>string</code> – Name of the window to destroy.

== Returns ==
Nothing.

== Details ==
* The window and every window below it are removed.
* If the window, or one of its children, is the window the client currently treats as active, destruction is deferred: the window is put on a list and destroyed during a later interface update, and a warning is logged. Until then the window still exists.
* A window waiting for deferred destruction is taken off the list again if [[API:CreateWindow|CreateWindow]] or [[API:CreateWindowFromTemplate|CreateWindowFromTemplate]] is called with its name. The old window is then kept instead of being destroyed.
* If the destroyed window had mouse capture, was the hovered window, or was the active window, the client clears that state.
* The root window cannot be destroyed.

== Errors ==
These are written to the UI log; the call returns normally.
* <code>ERROR: Calling 'DestroyWindow' on window '%s' does not exist.</code>
* <code>ERROR: The root window cannot be deleted.</code>
* <code>Warning: Calling 'DestroyWindow' on window '%s' has been deferred because this window or one of its children is active.</code>

== Example ==
From <code>easystem_glyphdisplay/source/glyphdisplay.lua</code>:
<pre>
DestroyWindow(GlyphDisplayInstances[instanceId].windowName)
</pre>

From <code>easystem_eventtext/source/system_eventtext.lua</code>:
<pre>
DestroyWindow( self.m_Anchor )
</pre>

== See also ==
* [[API:CreateWindow|CreateWindow]]
* [[API:CreateWindowFromTemplate|CreateWindowFromTemplate]]
* [[API:DoesWindowExist|DoesWindowExist]]