/
ColdC/Functions/
ColdC/Structure/
<head><title>ColdC: Function/Method Reference: clear_var()</title></head>

<body>

<h1 align=center><a href="/ColdC/">ColdC</a>: <a href="/ColdC/Functions/">Function/Method Reference</a>: clear_var()</h1>

<hr>

<p>
<font size=+1><i>INTEGER</i> <b>clear_var</b>(<i>SYMBOL <b>name</b></i>)</font>

<P><code>clear_var()</code> clears the value of a variable defined on an ancestor,
from the current object.  If this function is not called before an an ancestor
is removed, variables defined on that ancestor and set on the current object
<i>will remain</i>.  This function is also useful in reducing database usage,
as a cleared variable takes up no space, whereas a set variable (even to a
value of <code>0</code>) does.  If the object variable <i>name</i> is not
defined on the ancestor which defines the method calling
<code>clear_var()</code>, the error <code>~varnf</code> is thrown.  Upon
successful execution <code>clear_var()</code> returns <code>1</code>.
</p>
<hr size=4><p align=center><i>Last Modified on Jan 25 1996</i>
<br><i>Copyright &copy; 1995, 1996, Brandon Gillespie</i>
</body>