Difference between revisions of "UNSET()"

From Recital Documentation Wiki
Jump to: navigation, search
 
Line 1: Line 1:
{{YLM to do}}
 
 
 
==Class==
 
==Class==
 
+
Memory Variables
  
  
 
==Purpose==
 
==Purpose==
 
+
Delete a memory variable and free the storage that it was occupying
  
  
 
==Syntax==
 
==Syntax==
 
+
UNSET(<memvar>)
  
  
 
==See Also==
 
==See Also==
 
+
[[CLEAR MEMORY]], [[ISSET()]], [[PRIVATE]], [[PUBLIC]], [[RELEASE]], [[RESTORE]], [[RETURN]], [[SAVE]], [[STATIC]], [[STORE]], [[TYPE()]], [[VARTYPE()]]
  
  
 
==Description==
 
==Description==
 
+
The UNSET() function deletes a memory variable, and releases the storage that it was occupying.  Recital will automatically delete PRIVATE memory variables when a PROCEDURE or PROGRAM returns.  You cannot UNSET() memory variables belonging to other procedures. 
  
  
 
==Example==
 
==Example==
 
<code lang="recital">
 
<code lang="recital">
 
+
if isset(m_var)
 +
  unset(m_var)
 +
endif
 
</code>
 
</code>
  
==Products==
 
  
 +
==Products==
 +
Recital Database Server, Recital Mirage Server, Recital Terminal Developer
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 +
[[Category:Memory Variables]]
 +
[[Category:Memory Variables Functions]]

Revision as of 14:46, 21 October 2009

Class

Memory Variables


Purpose

Delete a memory variable and free the storage that it was occupying


Syntax

UNSET(<memvar>)


See Also

CLEAR MEMORY, ISSET(), PRIVATE, PUBLIC, RELEASE, RESTORE, RETURN, SAVE, STATIC, STORE, TYPE(), VARTYPE()


Description

The UNSET() function deletes a memory variable, and releases the storage that it was occupying. Recital will automatically delete PRIVATE memory variables when a PROCEDURE or PROGRAM returns. You cannot UNSET() memory variables belonging to other procedures.


Example

if isset(m_var)
  unset(m_var)
endif


Products

Recital Database Server, Recital Mirage Server, Recital Terminal Developer