$Curfile: Difference between revisions
Jump to navigation
Jump to search
m (minor wordsmithing) |
|||
| Line 1: | Line 1: | ||
<p>The <var>$Curfile</var> function returns the name of the file from which the current record has been selected. If the file is remote, <var>$Curfile</var> also returns the location of the file (in the form <var class="term">filename AT location</var>). <var>$Curfile</var> takes no arguments. </p> | <p> | ||
<p>You can use <var>$Curfile</var> in two places:</p> | The <var>$Curfile</var> function returns the name of the file from which the current record has been selected. If the file is remote, <var>$Curfile</var> also returns the location of the file (in the form <var class="term">filename AT location</var>). <var>$Curfile</var> takes no arguments. </p> | ||
<p> | |||
You can use <var>$Curfile</var> in two places:</p> | |||
<ul> | <ul> | ||
<li>In arithmetic and <var>Print</var> specifications within a record loop </li> | <li>In arithmetic and <var>Print</var> specifications within a record loop </li> | ||
<li>In an <var>In</var> clause to override a default file or group in a <var>Store Record</var> statement </li> | <li>In an <var>In</var> clause to override a default file or group in a <var>Store Record</var> statement </li> | ||
</ul> | </ul> | ||
<p>See [[Files, groups, and reference context#$CURFILE and $UPDATE functions|$CURFILE and $UPDATE functions]] for a discussion of default files and for examples of requests using <var>$Curfile</var>. | <p> | ||
<p>You cannot use an <var>In</var> clause that includes both <var>Member</var> and <var>$Curfile</var>. See [[Files, groups, and reference context#IN GROUP MEMBER clause|IN GROUP MEMBER clause]] for more information about the <var>In Group Member</var> clause. </p> | See [[Files, groups, and reference context#$CURFILE and $UPDATE functions|$CURFILE and $UPDATE functions]] for a discussion of default files and for examples of requests using <var>$Curfile</var>. </p> | ||
<p> | |||
You cannot use an <var>In</var> clause that includes both <var>Member</var> and <var>$Curfile</var>. See [[Files, groups, and reference context#IN GROUP MEMBER clause|IN GROUP MEMBER clause]] for more information about the <var>In Group Member</var> clause. </p> | |||
==See also== | ==See also== | ||
<ul> | <ul> | ||
<li>The <var>[[CURFILE parameter|CURFILE]]</var> parameter. | <li>The <var>[[CURFILE parameter|CURFILE]]</var> parameter. | ||
< | <p class="note"><b>Note:</b> It is recommended that you use <code>$Curfile</code> rather than <code>$View('CURFILE')</code>; in some circumstances <var>$Curfile</var> returns more accurate information than the <var>CURFILE</var> parameter.</p></li> | ||
<li>The <var>[[DEFCNTX parameter|DEFCNTX]]</var> parameter (which is quite similar to the <var>CURFILE</var> parameter but provides more information and with more accuracy), and the related <var>[[APDFCNTX parameter|APDFCNTX]]</var> parameter. | |||
<li>The <var>[[DEFAULT command|DEFAULT]]</var> and <var>[[OPEN file command|OPEN]]</var> commands, which reset the file/group context. | <li>The <var>[[DEFCNTX parameter|DEFCNTX]]</var> parameter (which is quite similar to the <var>CURFILE</var> parameter but provides more information and with more accuracy), and see the related <var>[[APDFCNTX parameter|APDFCNTX]]</var> parameter. </li> | ||
<li>The <var>[[OPENC command|OPENC</var>]] command does <b>not</b> reset the file/group context. | |||
<li>The <var>[[CLOSE command|CLOSE</var>]] command, which might reset the file/group context. | <li>The <var>[[DEFAULT command|DEFAULT]]</var> and <var>[[OPEN file command|OPEN]]</var> commands, which reset the file/group context. </li> | ||
<li>The <var>[[OPENC command|OPENC</var>]] command, which does <b>not</b> reset the file/group context.</li> | |||
<li>The <var>[[CLOSE command|CLOSE</var>]] command, which might reset the file/group context. </li> | |||
</ul> | </ul> | ||
[[Category:SOUL $functions]] | [[Category:SOUL $functions]] | ||
Revision as of 21:52, 13 May 2015
The $Curfile function returns the name of the file from which the current record has been selected. If the file is remote, $Curfile also returns the location of the file (in the form filename AT location). $Curfile takes no arguments.
You can use $Curfile in two places:
- In arithmetic and Print specifications within a record loop
- In an In clause to override a default file or group in a Store Record statement
See $CURFILE and $UPDATE functions for a discussion of default files and for examples of requests using $Curfile.
You cannot use an In clause that includes both Member and $Curfile. See IN GROUP MEMBER clause for more information about the In Group Member clause.
See also
- The CURFILE parameter.
Note: It is recommended that you use
$Curfilerather than$View('CURFILE'); in some circumstances $Curfile returns more accurate information than the CURFILE parameter. - The DEFCNTX parameter (which is quite similar to the CURFILE parameter but provides more information and with more accuracy), and see the related APDFCNTX parameter.
- The DEFAULT and OPEN commands, which reset the file/group context.
- The OPENC command, which does not reset the file/group context.
- The CLOSE command, which might reset the file/group context.