GuiClose
Jump to navigation
Jump to search
guiClose
Closes an RML document and releases its runtime handle.
Syntax
bool guiClose(DocumentHandle document)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
document |
DocumentHandle |
yes | The document to close. |
Returns
Returns true when the document is closed; otherwise returns false.
Examples
Close a temporary dialog:
guiClose(dialogDocument)
dialogDocument = nil
Notes
- Available only in client-side resource scripts.
- Do not use the document handle after it has been closed.