$Delg Sys: Difference between revisions
m (1 revision) |
(Automatically generated page update) |
||
| (21 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Delete system-wide global</span> | <span class="pageSubtitle">Delete system-wide global</span> | ||
<p class=" | <p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Delg_Sys function is the [[DeleteGlobal (System subroutine)]].</p> | ||
This function allows a user to delete a <var class="product">Model 204</var> "global variable" which has a system-wide scope. Doing this will let the value of the $GETG function or dummy string ("?& | This function allows a user to delete a <var class="product">Model 204</var> "global variable" which has a system-wide scope. Doing this will let the value of the $GETG function or dummy string ("?&") substitution for the variable default to the current user global variable with the same name, or it may not affect their results, depending on the scope search order. The order in which the different scopes of global variables are searched can be controlled using <var>$SirParm</var> parameters: for $GETG, with 'GETGSYS', and for dummy strings, with 'DUMMYSYS'. | ||
The $Delg_Sys function accepts one argument and returns zero, indicating success, or a number indicating the cause of error, if there is one. | The <var>$Delg_Sys</var> function accepts one argument and returns zero, indicating success, or a number indicating the cause of error, if there is one. | ||
The first argument is the name of the global variable to be deleted. This is an optional argument; it defaults to the null string. | The first argument is the name of the global variable to be deleted. This is an optional argument; it defaults to the null string. | ||
| Line 12: | Line 12: | ||
System administrator privileges are required to invoke this $function. | System administrator privileges are required to invoke this $function. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax">< | <p class="syntax"><span class="term">%rc</span> = <span class="literal">$Delg_Sys</span>(<span class="term">[glob_name</span>]) | ||
< | |||
< | |||
</p> | </p> | ||
<p class=" | |||
<p class="code"> | <p> | ||
<var class="term">%rc</var> is set to 0 or to an error indicator.</p> | |||
===Return codes=== | |||
<p class="code">0 - No errors | |||
1 - Not system administrator | |||
</p> | </p> | ||
Retrieval of system global variables is highly efficient; updates, however, are not, so use this $function appropriately | ==Usage notes== | ||
<ul> | |||
<li>Retrieval of system global variables is highly efficient; updates, however, are not, so use this $function appropriately. | |||
<li>For an explanation of the use of system global variables, see <var>[[$Setg_Sys]]</var>. For an explanation of <var>$SirParm</var>, see <var>[[$SirParm]]</var>. | |||
</ul> | |||
[[Category:$Functions|$Delg_Sys]] | [[Category:$Functions|$Delg_Sys]] | ||
Latest revision as of 22:51, 20 September 2018
Delete system-wide global
Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Delg_Sys function is the DeleteGlobal (System subroutine).
This function allows a user to delete a Model 204 "global variable" which has a system-wide scope. Doing this will let the value of the $GETG function or dummy string ("?&") substitution for the variable default to the current user global variable with the same name, or it may not affect their results, depending on the scope search order. The order in which the different scopes of global variables are searched can be controlled using $SirParm parameters: for $GETG, with 'GETGSYS', and for dummy strings, with 'DUMMYSYS'.
The $Delg_Sys function accepts one argument and returns zero, indicating success, or a number indicating the cause of error, if there is one.
The first argument is the name of the global variable to be deleted. This is an optional argument; it defaults to the null string.
System administrator privileges are required to invoke this $function.
Syntax
%rc = $Delg_Sys([glob_name])
%rc is set to 0 or to an error indicator.
Return codes
0 - No errors 1 - Not system administrator