$Context: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (link repair) |
||
| (37 intermediate revisions by 5 users not shown) | |||
| 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=" | <p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the <var>$Context</var> function.</p> | ||
<var>$Context</var> allows a user to determine if a string contains the name of an open file or [[Files, groups, and reference context#File groups|group]]. | |||
<var>$Context</var> accepts one argument and returns a numeric code. | <var>$Context</var> accepts one argument and returns a numeric code. | ||
==Syntax== | |||
<p class="syntax"><span class="term">%result</span> = <span class="literal">$Context</span>(<span class="term">fgname</span>) | |||
</p> | |||
<table> | |||
<tr><th>%result</th> | |||
<td>A numeric variable that is set to indicate the success of the function: | |||
<p class="code">0 - String does not specify an open file or group | |||
1 - String specifies an open group | |||
2 - String specifies an open file | |||
</p></td></tr> | |||
<tr><th>fgname</th> | |||
<td>The name to be tested. This name can be either of these: | |||
<ul> | <ul> | ||
<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> | |||
<li>A qualified name that explicitly indicates whether <var>$Context</var> is to act on a file or group. </li> | |||
<li>A qualified name that explicitly indicates whether <var>$Context</var> is to act on a file or group. | |||
</ul> | </ul> | ||
<p> | |||
If | If <var class="term">fgname</var> is not specified, the default file or group at compile time is used. </p> | ||
<p> | |||
Some examples of qualified names follow: | Some examples of qualified names follow: </p> | ||
<p class="code"> | <p class="code">'TEMP GROUP FOO' | ||
'FILE HOHO' | |||
'PERM GROUP CHUCKLES' | |||
'GROUP KRUSTY' | |||
</p> | </p> | ||
<p class=" | <p class="note"><b>Note:</b> The last example is not fully qualified, so <var>$Context</var> first looks for a temporary group, 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. </p></td></tr> | ||
</table> | |||
< | ==Examples== | ||
<ol> | |||
<li>In the following example, <code>%rc</code> is set to 1 if file <code>KRUSTY</code> is open: | |||
<p class="code">%rc = $Context( 'FILE KRUSTY' ) | |||
</ | |||
<p class=" | |||
</p> | </p> | ||
In the following example, % | <li>In the following example, <code>%rc</code> is set to 1 if <code>BURNS</code> identifies an open file, 2 if <code>BURNS</code> identifies an open group, and 0 if it identifies neither: | ||
< | |||
</ | |||
<p class="code">%rc = $Context( 'BURNS' ) | |||
<p class="code"> % | |||
</p> | </p> | ||
In the following example, % | <li>In the following example, <code>%rc</code> is set to 2 if <code>NUKEM</code> is open as a temporary group, and set to 0 otherwise: | ||
<p class="code"> % | <p class="code">%rc = $Context( 'TEMP GROUP NUKEM' ) | ||
</p> | </p> | ||
</ol> | |||
==Products authorizing {{PAGENAMEE}}== | |||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius | <li>[[Sirius Functions]]</li> | ||
<li>[[Fast/Unload User Language Interface]]</li> | <li>[[Fast/Unload User Language Interface]]</li> | ||
<li>[[Janus Open Client]]</li> | <li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | ||
<li>[[Janus Open Server]]</li> | <li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li> | ||
<li>[[Janus Sockets]]</li> | <li>[[Janus Sockets]]</li> | ||
<li>[[Janus Web Server]]</li> | <li>[[Janus Web Server]]</li> | ||
<li> | <li>Japanese functions</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$Context]] | [[Category:$Functions|$Context]] | ||
Latest revision as of 18:15, 27 April 2018
Determine if string is name of open file or group
Note: Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Context function.
$Context 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.
Syntax
%result = $Context(fgname)
| %result | A numeric variable that 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 |
|---|---|
| fgname | The name to be tested. This name can be either of these:
If fgname 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: The last example is not fully qualified, so $Context first looks for a temporary group, 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. |
Examples
- In the following example,
%rcis set to 1 if fileKRUSTYis open:%rc = $Context( 'FILE KRUSTY' )
- In the following example,
%rcis set to 1 ifBURNSidentifies an open file, 2 ifBURNSidentifies an open group, and 0 if it identifies neither:%rc = $Context( 'BURNS' )
- In the following example,
%rcis set to 2 ifNUKEMis open as a temporary group, and set to 0 otherwise:%rc = $Context( 'TEMP GROUP NUKEM' )