$Close - Revision history

DCameron: /* Products authorizing {{PAGENAMEE}} */

2018-11-07T12:51:52Z

Products authorizing {{PAGENAMEE}}

← Older revision		Revision as of 12:51, 7 November 2018
Line 50:		Line 50:
	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
	<ul class="smallAndTightList">		<ul class="smallAndTightList">
	<li>[[~~List of $functions~~\|~~Sirius functions~~]]</li>		<li>[[SirPro\|SirPro]]</li>

	</ul>		</ul>

DCameron at 12:49, 7 November 2018

2018-11-07T12:49:58Z

← Older revision		Revision as of 12:49, 7 November 2018
Line 47:		Line 47:
	End		End
	</p>		</p>

			==Products authorizing {{PAGENAMEE}}==
			<ul class="smallAndTightList">
			<li>[[List of $functions\|Sirius functions]]</li>

			</ul>
			<p>
			</p>


	[[Category:$Functions\|$Close]]		[[Category:$Functions\|$Close]]

JAL: "SOUL" replaces "UL"

2018-05-18T16:43:31Z

"SOUL" replaces "UL"

← Older revision		Revision as of 16:43, 18 May 2018
Line 1:		Line 1:
	{{DISPLAYTITLE:$Close}}		{{DISPLAYTITLE:$Close}}
	<span class="pageSubtitle">Close file or group in ~~User Language~~ request</span>		<span class="pageSubtitle">Close file or group in SOUL request</span>

	<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the <var>$Close</var> function. </p>		<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the <var>$Close</var> function. </p>

JAL: misc formatting

2018-05-18T16:42:03Z

misc formatting

← Older revision		Revision as of 16:42, 18 May 2018
Line 2:		Line 2:
	<span class="pageSubtitle">Close file or group in User Language request</span>		<span class="pageSubtitle">Close file or group in User Language request</span>

	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $Close function.</p>		<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the <var>$Close</var> function. </p>

	The <var>$Close</var> function allows a user to close a [[~~Introduction_to_User_Language~~#Files\|file]] or [[Files,~~_groups~~,~~_and_reference_context~~#~~File_groups~~\|group]] from within a <var class="product">~~User Language~~</var> request.		The <var>$Close</var> function allows a user to close a [[Introduction to User Language#Files\|file]] or [[Files, groups, and reference context#File groups\|group]] from within a <var class="product">SOUL</var> request.

	<var>$Close</var> accepts one argument and returns a numeric code. It is also [[Calling Sirius Mods $functions\|callable]].		<var>$Close</var> accepts one argument and returns a numeric code. It is also [[Calling Sirius Mods $functions\|callable]].
Line 12:		Line 12:
	</p>		</p>

			===Syntax terms===
			<table>
			<tr><th>%result</th>
			<td>A numerical variable set to indicate the success of the function. See [[#Status codes\|Status codes]]. </td></tr>

			<tr><th>fgname</th>
			<td>The name of the file or group to be closed. This name can be unqualified or qualified. If unqualified, the standard Model 204 search order (TEMP GROUP, PERM GROUP, FILE) is used to try to identify the file or group. If qualified, this name explicitly indicates whether <var>$Close</var> is to act on a file or group.
	<p>		<p>
	~~<var class="term">%result</var> is set to indicate the success of the function.</p>~~		Some examples of qualified names are: </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 :
	<p class="code"> 'TEMP GROUP FOO'		<p class="code"> 'TEMP GROUP FOO'
	'FILE HOHO'		'FILE HOHO'
	'PERM GROUP CHUCKLES'		'PERM GROUP CHUCKLES'
	'GROUP KRUSTY'		'GROUP KRUSTY' </p>
	</p>		<p>
	Note that the last example is not fully qualified so ~~that~~ <var>$Close</var> will first look for a temporary group and then a permanent group.		Note that the last example is not fully qualified, so <var>$Close</var> will first look for a temporary group and then a permanent group. </p>
			</td></tr>
			</table>

	===Status codes===		===Status codes===
	The <var>$Close</var> function operates like the <var>[[CLOSE command]]</var>, only it allows you to close a file from within a <var class="product">~~User Language~~</var> request. <var>$Close</var> ~~has some~~ restrictions~~, which~~ are listed below among the non-0 values of ~~the returned~~ <var class="term">%result</var>. ~~Basically~~, you cannot close a file or group that has requests compiled against it, has currently included procedures, or is a non-optional subsystem file or group:		The <var>$Close</var> function operates like the <var>[[CLOSE command]]</var>, only it allows you to close a file from within a <var class="product">SOUL</var> request. <var>$Close</var> restrictions are listed below among the non-zero values of <var class="term">%result</var>. In short, you cannot close a file or group that has requests compiled against it, has currently included procedures, or is a non-optional subsystem file or group:
	<p class="code">		<p class="code"> 0 - File/group closed
	0 - File/group closed
	1 - File/group name missing		1 - File/group name missing
	2 - File/group not open		2 - File/group not open
	3 - Can't close because of INCLUDE'd proc		3 - Can't close because of INCLUDE'd proc
	4 - Can't close because compiled code accesses file/group, or ~~the~~ file is ~~the~~ default file.		4 - Can't close because compiled code accesses file/group, or file is group default file
	5 - Can't close required subsystem member		5 - Can't close required subsystem member
	6 - Can't close member of open temp group		6 - Can't close member of open temp group
Line 35:		Line 42:

	==Example==		==Example==
	The following program closes file 'KRUSTY'.		The following program closes file <code>KRUSTY</code>:
	<p class="code"> B		<p class="code">b
	%RC = $Close( 'KRUSTY' )		%rc = $Close('KRUSTY')
	~~END~~		End
	</p>		</p>
	~~<p class="code">~~

	[[Category:$Functions\|$Close]]		[[Category:$Functions\|$Close]]

DCameron: /* Status codes */

2018-01-24T12:37:24Z

Status codes

← Older revision		Revision as of 12:37, 24 January 2018
Line 29:		Line 29:
	2 - File/group not open		2 - File/group not open
	3 - Can't close because of INCLUDE'd proc		3 - Can't close because of INCLUDE'd proc
	4 - Can't close because compiled code accesses file/group~~. This would include~~ the file ~~being~~ the default ~~file, even if the proc doesn't directly reference the~~ file.		4 - Can't close because compiled code accesses file/group, or the file is the default file.
	5 - Can't close required subsystem member		5 - Can't close required subsystem member
	6 - Can't close member of open temp group		6 - Can't close member of open temp group

DCameron: /* Status codes */

2018-01-24T12:36:14Z

Status codes

← Older revision		Revision as of 12:36, 24 January 2018
Line 29:		Line 29:
	2 - File/group not open		2 - File/group not open
	3 - Can't close because of INCLUDE'd proc		3 - Can't close because of INCLUDE'd proc
	4 - Can't close because compiled code accesses file/group		4 - Can't close because compiled code accesses file/group. This would include the file being the default file, even if the proc doesn't directly reference the file.
	5 - Can't close required subsystem member		5 - Can't close required subsystem member
	6 - Can't close member of open temp group		6 - Can't close member of open temp group

DCameron at 12:32, 24 January 2018

2018-01-24T12:32:07Z

← Older revision		Revision as of 12:32, 24 January 2018
Line 4:		Line 4:
	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $Close function.</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $Close function.</p>

	The <var>$Close</var> function allows a user to close a file or [[Files,_groups,_and_reference_context#File_groups\|group]] from within a <var class="product">User Language</var> request.		The <var>$Close</var> function allows a user to close a [[Introduction_to_User_Language#Files\|file]] or [[Files,_groups,_and_reference_context#File_groups\|group]] from within a <var class="product">User Language</var> request.

	<var>$Close</var> accepts one argument and returns a numeric code. It is also [[Calling Sirius Mods $functions\|callable]].		<var>$Close</var> accepts one argument and returns a numeric code. It is also [[Calling Sirius Mods $functions\|callable]].

DCameron at 12:27, 24 January 2018

2018-01-24T12:27:30Z

← Older revision		Revision as of 12:27, 24 January 2018
Line 4:		Line 4:
	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $Close function.</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $Close function.</p>

	The <var>$Close</var> function allows a user to close a file or group from within a <var class="product">User Language</var> request.		The <var>$Close</var> function allows a user to close a file or [[Files,_groups,_and_reference_context#File_groups\|group]] from within a <var class="product">User Language</var> request.

	<var>$Close</var> accepts one argument and returns a numeric code. It is also [[Calling Sirius Mods $functions\|callable]].		<var>$Close</var> accepts one argument and returns a numeric code. It is also [[Calling Sirius Mods $functions\|callable]].

JALWiccan: Automatically generated page update

2013-07-18T20:29:59Z

Automatically generated page update

← Older revision		Revision as of 20:29, 18 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Close file or group in User Language request</span>		<span class="pageSubtitle">Close file or group in User Language request</span>

	<p class="~~warning~~">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $Close function.</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $Close function.</p>

	The <var>$Close</var> function allows a user to close a file or group from within a <var class="product">User Language</var> request.		The <var>$Close</var> function allows a user to close a file or group from within a <var class="product">User Language</var> request.

Dme at 13:43, 6 May 2013

2013-05-06T13:43:04Z

← Older revision		Revision as of 13:43, 6 May 2013
Line 23:		Line 23:

	===Status codes===		===Status codes===
			The <var>$Close</var> function operates like the <var>[[CLOSE command]]</var>, only it allows you to close a file from within a <var class="product">User Language</var> request. <var>$Close</var> has some restrictions, which are listed below among the non-0 values of the returned <var class="term">%result</var>. Basically, you cannot close a file or group that has requests compiled against it, has currently included procedures, or is a non-optional subsystem file or group:
	<p class="code">		<p class="code">
	0 - File/group closed		0 - File/group closed