$Update: Difference between revisions
m (→$CURFILE and $UPDATE functions: use mixed case) |
|||
| Line 1: | Line 1: | ||
<p>The $ | <p> | ||
The $Update function returns the name of the group update file (in group context) or the current file (in file context). If the file is remote, $Update also returns the location of the file (in the form <var class="term">filename</var> AT <var class="term">location</var>). If no group update file is defined, $Update returns a null (zero-length) string. </p> | |||
<b>Syntax</b> | <b>Syntax</b> | ||
<p>The format of the $ | <p> | ||
<p class="syntax">$ | The format of the $Update function is:</p> | ||
<p class="syntax">$Update <var>[</var>(<span class="term">name</span>)<var>] </var> | |||
</p> | </p> | ||
<p>where the <var class="term">name</var> argument overrides the default file or group context for the function. </p> | <p> | ||
<p>The format for this argument is:</p> | where the <var class="term">name</var> argument overrides the default file or group context for the function. </p> | ||
<p>$ | <p> | ||
<p>If the file name/group name argument is omitted or null, the default context is the context of the statement that contains the function. </p> | The format for this argument is:</p> | ||
<p class="note"><b>Note:</b> You cannot use an IN clause that includes both MEMBER and $ | <p> | ||
<p>$ | $Update can be used to indicate the name of the update file in the current group, but the name argument must not be specified. In addition to its use in arithmetic expressions and PRINT specifications, $Update also can be used as the file name in an IN clause. $Curfile and $Update are described in further detail in [[Files, groups, and reference context]].</p> | ||
<p> | |||
If the file name/group name argument is omitted or null, the default context is the context of the statement that contains the function. </p> | |||
<p class="note"><b>Note:</b> You cannot use an IN clause that includes both MEMBER and $Update. See [[Files, groups, and reference context#IN GROUP MEMBER clause|IN GROUP MEMBER clause]] for information. </p> | |||
<p> | |||
$Update compresses consecutive spaces to one space. For example,:</p> | |||
<p class="code">'OWNERS AT DALL' | <p class="code">'OWNERS AT DALL' | ||
</p> | </p> | ||
<p>returns:</p> | <p> | ||
returns:</p> | |||
<p class="code">'OWNERS AT DALLAS' | <p class="code">'OWNERS AT DALLAS' | ||
</p> | </p> | ||
[[Category:SOUL $functions]] | [[Category:SOUL $functions]] | ||
Latest revision as of 22:05, 13 May 2015
The $Update function returns the name of the group update file (in group context) or the current file (in file context). If the file is remote, $Update also returns the location of the file (in the form filename AT location). If no group update file is defined, $Update returns a null (zero-length) string.
Syntax
The format of the $Update function is:
$Update [(name)]
where the name argument overrides the default file or group context for the function.
The format for this argument is:
$Update can be used to indicate the name of the update file in the current group, but the name argument must not be specified. In addition to its use in arithmetic expressions and PRINT specifications, $Update also can be used as the file name in an IN clause. $Curfile and $Update are described in further detail in Files, groups, and reference context.
If the file name/group name argument is omitted or null, the default context is the context of the statement that contains the function.
Note: You cannot use an IN clause that includes both MEMBER and $Update. See IN GROUP MEMBER clause for information.
$Update compresses consecutive spaces to one space. For example,:
'OWNERS AT DALL'
returns:
'OWNERS AT DALLAS'