SOUL $functions - Revision history

Alex: /* List of standard $functions */

2025-03-25T02:36:44Z

List of standard $functions

← Older revision		Revision as of 02:36, 25 March 2025
Line 77:		Line 77:
	<tr><td>[[$Curfile]]</td><td>Name of the file from which the current record has been selected.</td></tr>		<tr><td>[[$Curfile]]</td><td>Name of the file from which the current record has been selected.</td></tr>
	<tr><td>[[$Currec]]</td><td>Integer equal to the internal number of the current record.</td></tr>		<tr><td>[[$Currec]]</td><td>Integer equal to the internal number of the current record.</td></tr>
			<tr><td>[[$CurrecId]]</td><td>Get the <var class="product">Imagine</var> recordId of the current record.</td></tr>
	<tr><td>[[$C2D]]</td><td>Convert binary byte string to integer</td></tr>		<tr><td>[[$C2D]]</td><td>Convert binary byte string to integer</td></tr>
	<tr><td>[[$C2X]]</td><td>A translation of each byte within a character string to its two-byte hexadecimal representation.</td></tr>		<tr><td>[[$C2X]]</td><td>A translation of each byte within a character string to its two-byte hexadecimal representation.</td></tr>

JDamon at 22:57, 25 October 2020

2020-10-25T22:57:35Z

← Older revision		Revision as of 22:57, 25 October 2020
Line 86:		Line 86:
	<tr><td>[[$DateCnv]]</td><td>Date converted to a format specified by the user.</td></tr>		<tr><td>[[$DateCnv]]</td><td>Date converted to a format specified by the user.</td></tr>
	<tr><td>[[$DateDif]]</td><td>Difference in days between two dates.</td></tr>		<tr><td>[[$DateDif]]</td><td>Difference in days between two dates.</td></tr>
			<tr><td>[[$DateJ]]</td><td>Current date in "yy.ddd" format.</td></tr>
	<tr><td>[[$DateP]]</td><td>Current date in "dd mon yy" format.</td></tr>		<tr><td>[[$DateP]]</td><td>Current date in "dd mon yy" format.</td></tr>
	<tr><td>[[$DAY]]</td><td>Day name of the input day-number.</td></tr>		<tr><td>[[$DAY]]</td><td>Day name of the input day-number.</td></tr>

Dme at 00:05, 11 November 2019

2019-11-11T00:05:00Z

JAL: added (manually) a row for $JpStatL

2018-09-27T16:25:03Z

added (manually) a row for $JpStatL

← Older revision		Revision as of 16:25, 27 September 2018
Line 167:		Line 167:
	<tr><td>[[$Jobcode]]</td><td>Allows a request that is part of one step of a <var class="product">Model 204</var> batch run to communicate with a subsequent step.</td></tr>		<tr><td>[[$Jobcode]]</td><td>Allows a request that is part of one step of a <var class="product">Model 204</var> batch run to communicate with a subsequent step.</td></tr>
	<tr><td>[[$JpStat]]</td><td>Retrieve Janus port's statistics into string</td></tr>		<tr><td>[[$JpStat]]</td><td>Retrieve Janus port's statistics into string</td></tr>
			<tr><td>[[$JpStatL]]</td><td>Retrieve statistics for set of Janus pors into $list</td></tr>
	<tr><td>[[$LangSpc]]</td><td>String containing the binary value of a character in a specified language.</td></tr>		<tr><td>[[$LangSpc]]</td><td>String containing the binary value of a character in a specified language.</td></tr>
	<tr><td>[[$LangSrt]]</td><td>A binary string translated to sort according to the NLSORT macro for the specified language.</td></tr>		<tr><td>[[$LangSrt]]</td><td>A binary string translated to sort according to the NLSORT macro for the specified language.</td></tr>

JAL: add category

2018-04-23T18:50:29Z

add category

← Older revision		Revision as of 18:50, 23 April 2018
Line 516:		Line 516:

	<p>Customers are individually responsible for any functions they write. Rocket Software takes no responsibility for user-written functions or their documentation.</p>		<p>Customers are individually responsible for any functions they write. Rocket Software takes no responsibility for user-written functions or their documentation.</p>

			[[Category:SOUL]]

JAL: /* List of standard $functions */ add link

2018-04-23T17:53:47Z

List of standard $functions: add link

← Older revision		Revision as of 17:53, 23 April 2018
Line 25:		Line 25:
	<ul>		<ul>
	<li>[[#Using_functions\|Using functions]], which reviews coding in <var class="product">SOUL</var> with $functions </li>		<li>[[#Using_functions\|Using functions]], which reviews coding in <var class="product">SOUL</var> with $functions </li>

			<li>[[Notation conventions]], which provides a description of the conventions used in syntax on individual $function pages. </li>
	</ul>		</ul>

JAL: temp update for name $ItsOpen and $ItsRemote

2017-07-31T16:09:57Z

temp update for name $ItsOpen and $ItsRemote

← Older revision		Revision as of 16:09, 31 July 2017
Line 160:		Line 160:
	<tr><td>[[$Index]]</td><td>After comparing two strings, a number equal to the first position within the first string at which the second string appears; the same function as $SCAN.</td></tr>		<tr><td>[[$Index]]</td><td>After comparing two strings, a number equal to the first position within the first string at which the second string appears; the same function as $SCAN.</td></tr>
	<tr><td>[[$Inflate]]</td><td>Decompress a longstring with inflate</td></tr>		<tr><td>[[$Inflate]]</td><td>Decompress a longstring with inflate</td></tr>
	<tr><td>[[$~~Itsopen~~]]</td><td>Whether or not a file is open.</td></tr>		<tr><td>[[$ItsOpen]]</td><td>Whether or not a file is open.</td></tr>
	<tr><td>[[$~~Itsremote~~]]</td><td>Whether the current file or group is remote or scattered.</td></tr>		<tr><td>[[$ItsRemote]]</td><td>Whether the current file or group is remote or scattered.</td></tr>
	<tr><td>[[$JobAuth]]</td><td>Determine if user has authorization for USE $JOB</td></tr>		<tr><td>[[$JobAuth]]</td><td>Determine if user has authorization for USE $JOB</td></tr>
	<tr><td>[[$Jobcode]]</td><td>Allows a request that is part of one step of a <var class="product">Model 204</var> batch run to communicate with a subsequent step.</td></tr>		<tr><td>[[$Jobcode]]</td><td>Allows a request that is part of one step of a <var class="product">Model 204</var> batch run to communicate with a subsequent step.</td></tr>

Alex at 17:28, 30 May 2017

2017-05-30T17:28:01Z

← Older revision		Revision as of 17:28, 30 May 2017
Line 293:		Line 293:
	<tr><td>[[$Scan]]</td><td>After comparing two strings, a number equal to the first position within the first string at which the second string appears; the same function as $INDEX.</td></tr>		<tr><td>[[$Scan]]</td><td>After comparing two strings, a number equal to the first position within the first string at which the second string appears; the same function as $INDEX.</td></tr>
	<tr><td>[[$Sclass]]</td><td>Current user's subsystem user class.</td></tr>		<tr><td>[[$Sclass]]</td><td>Current user's subsystem user class.</td></tr>
			<tr><td>[[$Screen_attr]]</td><td>Get screen item attributes as a blank-delimited string</td></tr>
			<tr><td>[[$Screen_clear]]</td><td>Clear tagged and/or modified attributes in a screen</td></tr>
			<tr><td>[[$Screen_mod]]</td><td>Set modified attribute for a screen item</td></tr>
	<tr><td>[[$ScrHide]]</td><td>Hide lines in SCREEN</td></tr>		<tr><td>[[$ScrHide]]</td><td>Hide lines in SCREEN</td></tr>
	<tr><td>[[$ScrSize]]</td><td>Change size of field on SCREEN</td></tr>		<tr><td>[[$ScrSize]]</td><td>Change size of field on SCREEN</td></tr>

JAL: typos

2016-09-23T19:54:42Z

typos

← Older revision		Revision as of 19:54, 23 September 2016
Line 20:		Line 20:
	The following table lists available <var class="product">SOUL</var> $functions, in alphabetical order. The list is not exhaustive (see the [[#otherLists\|table of other $function sets]], above).		The following table lists available <var class="product">SOUL</var> $functions, in alphabetical order. The list is not exhaustive (see the [[#otherLists\|table of other $function sets]], above).

	<p class="note"><b>Note:</b> Some of the $functions listed below are only available with the purchase of a Model 204 add-on product. The page ~~that describes~~ a %function ~~that requires a particular product purchase contains~~ an itemized list of the add-on products that authorize the use of the %function.</p>		<p class="note"><b>Note:</b> Some of the $functions listed below are only available with the purchase of a Model 204 add-on product. The individual page containing such a $function's full description has an itemized list of the add-on products that authorize the use of the $function.</p>
	<p>		<p>
	See also: </p>		See also: </p>

JAL: /* List of standard $functions */ typo

2016-09-23T18:37:09Z

List of standard $functions: typo

← Older revision		Revision as of 18:37, 23 September 2016
Line 21:		Line 21:

	<p class="note"><b>Note:</b> Some of the $functions listed below are only available with the purchase of a Model 204 add-on product. The page that describes a %function that requires a particular product purchase contains an itemized list of the add-on products that authorize the use of the %function.</p>		<p class="note"><b>Note:</b> Some of the $functions listed below are only available with the purchase of a Model 204 add-on product. The page that describes a %function that requires a particular product purchase contains an itemized list of the add-on products that authorize the use of the %function.</p>

	<p>		<p>
	See also: </p>		See also: </p>
Line 27:		Line 26:
	<li>[[#Using_functions\|Using functions]], which reviews coding in <var class="product">SOUL</var> with $functions </li>		<li>[[#Using_functions\|Using functions]], which reviews coding in <var class="product">SOUL</var> with $functions </li>
	</ul>		</ul>


	<div class="showVisit">		<div class="showVisit">

← Older revision		Revision as of 00:05, 11 November 2019
Line 114:		Line 114:
	<tr><td>[[$Ent]]</td><td>Do character entity substitution</td></tr>		<tr><td>[[$Ent]]</td><td>Do character entity substitution</td></tr>
	<tr><td>[[$Enter]]</td><td>Efficient terminal dialogue with users of data entry applications.</td></tr>		<tr><td>[[$Enter]]</td><td>Efficient terminal dialogue with users of data entry applications.</td></tr>
	<tr><td>[[$ErrClr]]</td><td>Clears the error message text returned by the $~~Errmsg~~ and $Fsterr functions.</td></tr>		<tr><td>[[$ErrClr]]</td><td>Clears the error message text returned by the $ErrMsg and $Fsterr functions.</td></tr>
	<tr><td>[[$~~Errmsg~~]]</td><td>Prefix and text of the last counting error or request cancellation message received.</td></tr>		<tr><td>[[$ErrMsg]]</td><td>Prefix and text of the last counting error or request cancellation message received.</td></tr>
	<tr><td>[[$ErrSet]]</td><td>Increment or clear number of counting errors, set $~~Errmsg~~</td></tr>		<tr><td>[[$ErrSet]]</td><td>Increment or clear number of counting errors, set $ErrMsg</td></tr>
	<tr><td>[[$E2A]]</td><td>Translate EBCDIC to ASCII</td></tr>		<tr><td>[[$E2A]]</td><td>Translate EBCDIC to ASCII</td></tr>
	<tr><td>[[$FakeEnt]]</td><td>Prepare fake ENTER to automatically satisfy next full screen read</td></tr>		<tr><td>[[$FakeEnt]]</td><td>Prepare fake ENTER to automatically satisfy next full screen read</td></tr>
Line 287:		Line 287:
	<tr><td>[[$RegexReplace]]</td><td>Replace matching strings</td></tr>		<tr><td>[[$RegexReplace]]</td><td>Replace matching strings</td></tr>
	<tr><td>[[$Remote]]</td><td>VTAMNAME value of the originating <var class="product">Model 204</var> region when using SNA Communications Server (formerly VTAM) TRANSFER to transfer between <var class="product">Model 204</var> regions.</td></tr>		<tr><td>[[$Remote]]</td><td>VTAMNAME value of the originating <var class="product">Model 204</var> region when using SNA Communications Server (formerly VTAM) TRANSFER to transfer between <var class="product">Model 204</var> regions.</td></tr>
	<tr><td>[[$~~Resetn~~]]</td><td>Reset or view M204 parameter</td></tr>		<tr><td>[[$ResetN]]</td><td>Reset or view M204 parameter</td></tr>
	<tr><td>[[$Reverse]]</td><td>Reversed order of a string.</td></tr>		<tr><td>[[$Reverse]]</td><td>Reversed order of a string.</td></tr>
	<tr><td>[[$RlcFile]]</td><td>Name of the file in which the last record locking conflict occurred.</td></tr>		<tr><td>[[$RlcFile]]</td><td>Name of the file in which the last record locking conflict occurred.</td></tr>