Discard include file: Difference between revisions

From ENIGMA
Jump to navigation Jump to search
m (→‎Notation: replacing function titles with notation using AWB, replaced: {{func| → {{FuncTitle|)
No edit summary
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Notation ==
{{FuncTitle|discard_include_file|fname}}
{{FuncTitle|discard_include_file|fname}}
== Description ==
== Description ==
General description of the function.
Discards the included file with the given name, freeing the memory it used.


== Parameters ==
== Parameters ==
*List parameters with a description of each.
{| class="funcpars"
! Parameter !! Data Type !! Description
|-
| fname || string || the name of the included file
|}


== Return Values ==
== Return Values ==
Document return values.
'''void''': This function does not return anything.


== Example Call ==
== Example Call ==
<syntaxhighlight lang="gml">
<syntaxhighlight lang="edl">
Example of using the function.
// demonstrates discarding an included file
discard_include_file("includefile");
</syntaxhighlight>
</syntaxhighlight>
[[Category:Function:Obsolete]]
[[Category:Function:Obsolete]]
{{DISPLAYTITLE:discard_include_file}}
 
__NOTOC__
__NOTOC__
{{Function:GM}}
{{Function:GM}}

Latest revision as of 12:32, 15 July 2013

Description

Discards the included file with the given name, freeing the memory it used.

Parameters

Parameter Data Type Description
fname string the name of the included file

Return Values

void: This function does not return anything.

Example Call

// demonstrates discarding an included file
discard_include_file("includefile");