43 lines
1.2 KiB
HTML
43 lines
1.2 KiB
HTML
<html>
|
|
<head>
|
|
<title>STAB_Destroy</title>
|
|
<meta name="Author" content="Joey">
|
|
<link rel="STYLESHEET" type="text/css" href="../webdocs.css">
|
|
</head>
|
|
<body>
|
|
<h1><a name="ape_stab_destroy"></a>STAB_Destroy</h3>
|
|
<p>The <b>STAB_Destroy</b> function releases memory used by a STAB (string table) object.
|
|
After the object is deleted, the specified handle is no longer valid.
|
|
</p>
|
|
|
|
<PRE class="syntax"><b>extern STAB_Destroy</b>
|
|
<b> float</b><i> handle</i> // handle to STAB object
|
|
</PRE>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
<dt><i>handle</i></dt>
|
|
<dd>[in] Handle to a STAB object previously returned from
|
|
<a href="stab_create.html"><b>STAB_Create</b></a>.
|
|
</dd>
|
|
</dl>
|
|
|
|
<h4>Remarks</h4>
|
|
<p>You need to call <b>STAB_Destroy</b> to release memory resources
|
|
used by the STAB object only if you no longer need the object before
|
|
the level exits. All STAB objects are automatically destroyed upon
|
|
level exit.</p>
|
|
<p>If <i>handle</i> is not a valid STAB handle, an error message will be printed
|
|
to the console.</p>
|
|
|
|
<h4>Example</h4>
|
|
<pre>extern STAB_Create handle
|
|
.
|
|
// Do some stuff with the STAB object,
|
|
// and then, when you are done...
|
|
.
|
|
extern STAB_Destroy handle</pre>
|
|
|
|
</body>
|
|
</html>
|