$Delg Sys: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$Delg_Sys}} | {{DISPLAYTITLE:$Delg_Sys}} | ||
<span class="pageSubtitle" | <span class="pageSubtitle">Delete system-wide global</span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Delg_Sys function is the [[DeleteGlobal (System subroutine)]].</p> | <p class="warning">Most Sirius $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 ''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'. | 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 ("?&amp.") 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 $Delg_Sys function accepts one argument and returns zero, indicating success, or a number indicating the cause of error, if there is one. | ||
Revision as of 21:21, 22 November 2011
Delete system-wide global
Most Sirius $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
<section begin="syntax" /> %RC = $Delg_Sys( glob_name ) <section end="syntax" />
$Delg_Sys Function
%RC is set to 0 or to an error indicator.
0 - No errors 1 - Not system administrator
$Delg_Sys return codes
Retrieval of system global variables is highly efficient; updates, however, are not, so use this $function appropriately.
For an explanation of the use of system global variables, see $Setg_Sys. For an explanation of $SirParm, see $SirParm.
This $function is new in Version 5.5 of the Sirius Mods.