View source for GuiClose

<!-- This page is generated automatically from the function definition: guiClose. -->
= guiClose =
Closes an RML document and releases its runtime handle.

== Syntax ==
<syntaxhighlight lang="lua">
bool guiClose(DocumentHandle document)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>document</code> || <code>DocumentHandle</code> || yes || The document to close.
|}

== Returns ==
Returns <code>true</code> when the document is closed; otherwise returns <code>false</code>.

== Examples ==
Close a temporary dialog:
<syntaxhighlight lang="lua" line>
guiClose(dialogDocument)
dialogDocument = nil
</syntaxhighlight>

== Notes ==
* Available only in client-side resource scripts.
* Do not use the document handle after it has been closed.

[[Category:Client Functions]]
[[Category:GUI Functions]]