View source for $DELG

<p>Deletes information stored in the global variable table by a $SETG function in the same or an earlier request.</p>
<p>The syntax of the $DELG function is:</p>
<p class="code">$DELG('globalvariable[*]')
</p>
<p>Where:</p>
<p>globalvariable[*] specifies the name of the global variable to delete. </p>
<p>You can specify the optional wildcard suffix, an asterisk (*), to delete all global variables with the same common prefix. You cannot delete all global variables by specifying the wildcard suffix only. </p>
<p>$DELG returns a completion code indication success or failure of the operation. Possible codes are:</p>
<table>
<tr class="head">
<th>Code </th>
<th>Meaning</th>
</tr>
<tr>
<td align="right">0 </td>
<td>Successful. Global variable(s) deleted.</td>
</tr>
<tr>
<td align="right">1 </td>
<td>Not found. No global variable found that matches the supplied argument.</td>
</tr>
<tr>
<td align="right">2 </td>
<td>Unsuccessful.</td>
</tr>
</table>
<b>Examples</b>
<p>Assuming the global variable table has been populated as follows:</p>
<p class="code">%RC = $SETG('GVAR','DATA')
%RC = $SETG('GVAR1','DATA1')
%RC = $SETG('DELETE','TARGET')
%RC = $SETG('GVAR2','DATA2')
%RC = $SETG('REMAINING','ENTRY')
%RC = $SETG('GVAR3','DATA3') 
</p>
<p>Then the following $DELG functions return: </p>
<table>
<tr class="head">
<th>Function </th>
<th>Returns... </th>
<th>And...</th>
</tr>
<tr>
<td>
<p class="code">%RC=$DELG('')
</p></td>
<td align="right">1</td>
<td>Does not alter the global variable table</td>
</tr>
<tr>
<td>
<p class="code">%RC=$DELG('DELETE')
</p></td>
<td align="right">0</td>
<td>Removes the entry DELETE from the global variable table</td>
</tr>
<tr>
<td>
<p class="code">%RC=$DELG('NOTFOUND')
</p></td>
<td align="right">1</td>
<td>Does not alter the variable table</td>
</tr>
<tr>
<td>
<p class="code">%RC=$DELG('GVAR*')
</p></td>
<td align="right">0 </td>
<td>Removes all GVARn entries, including GVAR, from the global variable table</td>
</tr>
<tr>
<td>
<p class="code">%RC=$DELG('*')
</p></td>
<td align="right">1</td>
<td>Does not alter the global variable table</td>
</tr>
</table>
<p>The resulting global variable table is: </p>
<p class="code">REMAINING=ENTRY
</p>
<p>For a full discussion of global variables refer to [[Global features]].</p>

[[Category:SOUL $functions]]