$Context: Difference between revisions
m (1 revision) |
m (1 revision) |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Determine if string is name of open file or group</span> | <span class="pageSubtitle">Determine if string is name of open file or group</span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Context function.</p> | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the <var>$Context</var> function.</p> | ||
The $Context function allows a user to determine if a string contains the name of an open file or group. | The <var>$Context</var> function allows a user to determine if a string contains the name of an open file or group. | ||
<var>$Context</var> accepts one argument and returns a numeric code. | <var>$Context</var> accepts one argument and returns a numeric code. | ||
| Line 12: | Line 12: | ||
<li>An unqualified name, in which case the standard <var class="product">Model 204</var> search order (TEMP GROUP, PERM GROUP, FILE) is used to identify the file or group. | <li>An unqualified name, in which case the standard <var class="product">Model 204</var> search order (TEMP GROUP, PERM GROUP, FILE) is used to identify the file or group. | ||
<li>A qualified name that explicitly indicates whether $Context is to act on a file or group. | <li>A qualified name that explicitly indicates whether <var>$Context</var> is to act on a file or group. | ||
</ul> | </ul> | ||
| Line 24: | Line 24: | ||
</p> | </p> | ||
Note that the last example is not fully qualified, so $Context first looks for a temporary group and then a permanent group. If the specified entity is a file that is only open as a member of a group, $Context returns a 0 indicating that the file is not open as an individual file. | Note that the last example is not fully qualified, so <var>$Context</var> first looks for a temporary group and then a permanent group. If the specified entity is a file that is only open as a member of a group, <var>$Context</var> returns a 0 indicating that the file is not open as an individual file. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><section begin="syntax" /> %RESULT = $Context(fgname) | <p class="syntax"><section begin="syntax" /> %RESULT = $Context(fgname) | ||
Revision as of 20:28, 19 October 2012
Determine if string is name of open file or group
Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Context function.
The $Context function allows a user to determine if a string contains the name of an open file or group.
$Context accepts one argument and returns a numeric code.
The only argument is the name to be tested. This name can be either:
- An unqualified name, in which case the standard Model 204 search order (TEMP GROUP, PERM GROUP, FILE) is used to identify the file or group.
- A qualified name that explicitly indicates whether $Context is to act on a file or group.
If this name is not specified, the default file or group at compile time is used.
Some examples of qualified names follow:
'TEMP GROUP FOO' 'FILE HOHO' 'PERM GROUP CHUCKLES' 'GROUP KRUSTY'
Note that the last example is not fully qualified, so $Context first looks for a temporary group and then a permanent group. If the specified entity is a file that is only open as a member of a group, $Context returns a 0 indicating that the file is not open as an individual file.
Syntax
<section begin="syntax" /> %RESULT = $Context(fgname) <section end="syntax" />
$Context Function
%RESULT is set to indicate the success of the function.
0 - String does not specify an open file or group 1 - String specifies an open group 2 - String specifies an open file
$Context return codes
In the following example, %RC is set to 1 if file KRUSTY is open:
%RC = $Context( 'FILE KRUSTY' )
In the following example, %RC is set to 1 if BURNS identifies an open file, 2 if BURNS identifies an open group, and 0 if it identifies neither:
%RC = $Context( 'BURNS' )
In the following example, %RC is set to 2 if NUKEM is open as a temporary group, and set to 0 otherwise:
%RC = $Context( 'TEMP GROUP NUKEM' )
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- Sir2000 Field Migration Facility
Products authorizing $Context