Difference between revisions of "UNSET()"

From Recital Documentation Wiki
Jump to: navigation, search
 
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{YLM to do}}
 
 
==Class==
 
 
 
 
 
==Purpose==
 
==Purpose==
 
+
Function to delete memory variables and free the storage that they were occupying
  
  
 
==Syntax==
 
==Syntax==
 
+
UNSET(<memvar>[,<memvar2>...])
  
  
 
==See Also==
 
==See Also==
 
+
[[CLEAR MEMORY]], [[ISSET()]], [[PRIVATE]], [[PUBLIC]], [[RELEASE]], [[RESTORE]], [[RETURN]], [[SAVE]], [[STORE]], [[TYPE()]], [[VARTYPE()]]
  
  
 
==Description==
 
==Description==
 
+
The UNSET() function deletes memory variables, and releases the storage that they were 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, Recital Server
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 +
[[Category:Memory Variables]]
 +
[[Category:Memory Variables Functions]]

Latest revision as of 15:18, 14 June 2011

Purpose

Function to delete memory variables and free the storage that they were occupying


Syntax

UNSET(<memvar>[,<memvar2>...])


See Also

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


Description

The UNSET() function deletes memory variables, and releases the storage that they were 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, Recital Server