ColdC: Function/Method Reference: clear_var()

INTEGER clear_var(SYMBOL name)

clear_var() 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 will remain. 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 0) does. If the object variable name is not defined on the ancestor which defines the method calling clear_var(), the error ~varnf is thrown. Upon successful execution clear_var() returns 1.