SetGlobal (System subroutine): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
m (→Syntax terms) |
||
| Line 7: | Line 7: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th><var>%(System)</var></th> | <tr><th><var>%(System)</var></th> | ||
<td>The class name in parentheses denotes a | <td>The class name in parentheses denotes a ÝÝNotation conventions for methods#Shared methods|shared¨¨ method. <var>SetGlobal</var> can also be invoked via a <var>System</var> object variable, which may be <var>Null</var>.</td></tr> | ||
<tr><th>name</th> | <tr><th>name</th> | ||
<td>A string that identifies the global to be set.</td></tr> | <td>A string that identifies the global to be set.</td></tr> | ||
| Line 28: | Line 28: | ||
<p class="code">%(system):setGlobal('PHLEGMATIC', 'STOLID') | <p class="code">%(system):setGlobal('PHLEGMATIC', 'STOLID') | ||
%setg_sys('PHLEGMATIC', 'STOLID')</p> | %setg_sys('PHLEGMATIC', 'STOLID')</p> | ||
<li>For more information about system globals, see [[System_class#System_and_subsystem_globals_and_strings|“System globals and strings”]].</ul> | <li>For more information about system globals, see [[System_class#System_and_subsystem_globals_and_strings|&#x201C;System globals and strings&#x201D;]].</ul> | ||
{{Template:System:SetGlobal footer}} | {{Template:System:SetGlobal footer}} | ||
Revision as of 20:38, 1 July 2011
Set a system-wide global (System class)
The SetGlobal shared subroutine sets a system-wide global.
Syntax
%(System):SetGlobal( name, value)
Syntax terms
| %(System) | The class name in parentheses denotes a ÝÝNotation conventions for methods#Shared methods|shared¨¨ method. SetGlobal can also be invoked via a System object variable, which may be Null. |
|---|---|
| name | A string that identifies the global to be set. |
| value | A string that identifies the new value for the global. |
Usage notes
- All errors result in request cancellation.
- It is not an error to set a global that is not set.
- Like $Setg_Sys, the SetGlobal method momentarily turns off multi-processing, so should not be used heavily in an MP/204 environment. SetString does not suffer this limitation and should be used in these situations.
Examples
The following statement sets the system global called CHOLERIC:
%(system):setGlobal('CHOLERIC', 'ANGRY')
See also
- The setGlobal method, in the System class, performs a function identical to the $setg_sys function. That is, the following two statements are identical:
%(system):setGlobal('PHLEGMATIC', 'STOLID') %setg_sys('PHLEGMATIC', 'STOLID')
- For more information about system globals, see “System globals and strings”.