$Close: Difference between revisions
(Automatically generated page update) |
(→Syntax) |
||
| Line 9: | Line 9: | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">%result</span> = <span class="literal">$Close</span>(<span class="term">fgname) | <p class="syntax"><span class="term">%result</span> = <span class="literal">$Close</span>(<span class="term">fgname</span>) | ||
</p> | </p> | ||
<p>%result is set to indicate the success of the function.</p> | <p> | ||
<var class="term">%result</var> is set to indicate the success of the function.</p> | |||
The only argument is the name of the file or group to be closed. This name can be either an unqualified name, in which case the standard 204 search order (TEMP GROUP, PERM GROUP, FILE) will be used to try to identify the file or group; or it can be a qualified name that explicitly indicates whether <var>$Close</var> is to act on a file or group. Some examples of qualified names are : | The only argument is the name of the file or group to be closed. This name can be either an unqualified name, in which case the standard 204 search order (TEMP GROUP, PERM GROUP, FILE) will be used to try to identify the file or group; or it can be a qualified name that explicitly indicates whether <var>$Close</var> is to act on a file or group. Some examples of qualified names are : | ||
<p class="code"> 'TEMP GROUP FOO' | <p class="code"> 'TEMP GROUP FOO' | ||
Revision as of 22:09, 10 April 2013
Close file or group in User Language request
Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $Close function.
The $Close function allows a user to close a file or group from within a User Language request.
$Close accepts one argument and returns a numeric code. It is also callable.
Syntax
%result = $Close(fgname)
%result is set to indicate the success of the function.
The only argument is the name of the file or group to be closed. This name can be either an unqualified name, in which case the standard 204 search order (TEMP GROUP, PERM GROUP, FILE) will be used to try to identify the file or group; or it can be a qualified name that explicitly indicates whether $Close is to act on a file or group. Some examples of qualified names are :
'TEMP GROUP FOO' 'FILE HOHO' 'PERM GROUP CHUCKLES' 'GROUP KRUSTY'
Note that the last example is not fully qualified so that $Close will first look for a temporary group and then a permanent group.
Status codes
0 - File/group closed 1 - File/group name missing 2 - File/group not open 3 - Can't close because of INCLUDE'd proc 4 - Can't close because compiled code accesses file/group 5 - Can't close required subsystem member 6 - Can't close member of open temp group
Example
The following program closes file 'KRUSTY'.
B %RC = $Close( 'KRUSTY' ) END