DEFCNTX and APDFCNTX parameters: Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 18: Line 18:
   
   
==Description==
==Description==
These parameters provide information about the default file or group context, that is, which file or group is used when a file-based operation is performed without the qualification provided by the <var>[[Basic SOUL statements and commands#IN clauses|IN]] clause.
These parameters provide information about the default file or group context; that is, which file or group is used when a file-based operation is performed without the qualification provided by the <var>[[Basic SOUL statements and commands#IN clauses|IN]] clause.
 
They are very similar to the <var>[[CURFILE parameter|CURFILE]]</var> parameter, with these differences:
<var>DEFCNTX</var> shows the default context when the request was compiled.
 
<var>APDFCNTX</var> shows the default context when the Apsy command was issued.
<p class="note"><b>Note:</b> If the default context when an Apsy command was issued is the same as one of the files or groups in the Apsy's definition, <var>APDFCNTX</var> returns the null string.
</p>
   
   
If there is no default context, the value of the parameters is the null string.
<ul>
<ul>
<li><var>CURFILE</var> returns a null string if the default context is a group. </li>
<li>The first word or two returned by <var>DEFCNTX</var> and <var>APDFCNTX</var>
<li>The first word or two returned by <var>DEFCNTX</var> and <var>APDFCNTX</var>
is the type of context: <code>FILE</code>,
is the type of context: <code>FILE</code>,
<code>TEMP GROUP</code>, or <code>PERM GROUP</code>. </li>
<code>TEMP GROUP</code>, or <code>PERM GROUP</code>.</li>


<li>The last word returned by <var>DEFCNTX</var> or <var>APDFCNTX</var>
<li>The last word returned by <var>DEFCNTX</var> or <var>APDFCNTX</var>
is the name of the file or group. </li>
is the name of the file or group.</li>
</ul>
<var>DEFCNTX</var> and <var>APDFCNTX</var> are very similar to the <var>[[CURFILE parameter|CURFILE]]</var> parameter, with these differences:
<ul>
<li><var>CURFILE</var> returns a null string if the default context is a group. </li>


<li><var>CURFILE</var> is affected by the <var>IN</var> clause prior to a <var>BEGIN</var> command and can be affected by the <var>In</var> clause prior to many SOUL statements. <var>DEFCNTX</var> and <var>APDFCNTX</var> are not affected by (either form of) the <var>IN</var> clause. </li>
<li><var>CURFILE</var> is affected by the <var>IN</var> clause prior to a <var>BEGIN</var> command and can be affected by the <var>In</var> clause prior to many SOUL statements. <var>DEFCNTX</var> and <var>APDFCNTX</var> are not affected by (either form of) the <var>IN</var> clause. </li>
<li><var>DEFCNTX</var> provides information about the default context when the request was compiled. </li>
<li><var>APDFCNTX</var> provides information not about the default context when the request was compiled, but the context when the Apsy command was issued.
<p class="note"><b>Note:</b> If the default context when an Apsy command was issued is the
same as one of the files or groups in the Apsy's definition, <var>APDFCNTX</var> returns the null string.
</p> </li>
</ul>
</ul>
===Usage===
If there is no default context, the value of the parameters is the null string.
In versions 7.4 and 7.5 of Model&nbsp;204, <var>DEFCNTX</var> and <var>APDFCNTX</var> are only available using the <var>$View</var> function. For example:
<blockquote class="note"><b>Notes:</b> In versions 7.4 and 7.5 of Model&nbsp;204, these parameters are only available using the <var>$View</var> function, for example:
<p class="code">print $view('DEFCNTX')</p>
<p class="code">print $view('DEFCNTX')</p>
<ul>
<ul>
<li>Prior to version 7.6, they are not available with the <var>VIEW</var> command.</li>
<li>As of version 7.6, they are available with the <var>VIEW</var> command.</li>


<li>In version 7.4, they were implemented as part of maintenance: Early Warning 740EW159.</li>
<li>In version 7.4, they were implemented as part of maintenance: Early Warning 740EW159.</li>
Line 53: Line 53:
<li>In version 7.5, they were implemented as part of maintenance: zap 75Z054.</li>
<li>In version 7.5, they were implemented as part of maintenance: zap 75Z054.</li>
</ul>
</ul>
</blockquote>


==See also==
==See also==

Revision as of 23:24, 12 July 2017

Default file or group context

and

Default file or group context when APSY command issued

Summary

Default value
None
Parameter type
User
Where set
View-only
Related products
All
Introduced
Model 204 V7.4 or earlier

Description

These parameters provide information about the default file or group context; that is, which file or group is used when a file-based operation is performed without the qualification provided by the IN clause.

DEFCNTX shows the default context when the request was compiled.

APDFCNTX shows the default context when the Apsy command was issued.

Note: If the default context when an Apsy command was issued is the same as one of the files or groups in the Apsy's definition, APDFCNTX returns the null string.

If there is no default context, the value of the parameters is the null string.

  • The first word or two returned by DEFCNTX and APDFCNTX is the type of context: FILE, TEMP GROUP, or PERM GROUP.
  • The last word returned by DEFCNTX or APDFCNTX is the name of the file or group.

DEFCNTX and APDFCNTX are very similar to the CURFILE parameter, with these differences:

  • CURFILE returns a null string if the default context is a group.
  • CURFILE is affected by the IN clause prior to a BEGIN command and can be affected by the In clause prior to many SOUL statements. DEFCNTX and APDFCNTX are not affected by (either form of) the IN clause.

Usage

In versions 7.4 and 7.5 of Model 204, DEFCNTX and APDFCNTX are only available using the $View function. For example:

print $view('DEFCNTX')

  • As of version 7.6, they are available with the VIEW command.
  • In version 7.4, they were implemented as part of maintenance: Early Warning 740EW159.
  • In version 7.5, they were implemented as part of maintenance: zap 75Z054.

See also

  • The CURFILE parameter.
  • The $Curfile function.
  • The DEFAULT and OPEN commands, which reset the file/group context.
  • The OPENC command does not reset the file/group context.
  • The CLOSE command, which might reset the file/group context.
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=DEFCNTX_and_APDFCNTX_parameters&oldid=103728"