$Field List - Revision history

JALWiccan: Automatically generated page update

2018-09-20T22:51:26Z

Automatically generated page update

← Older revision		Revision as of 22:51, 20 September 2018
Line 2:		Line 2:
	<span class="pageSubtitle">Return field values into a $list</span>		<span class="pageSubtitle">Return field values into a $list</span>

	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for <var>$Field_List</var> is the <var>Stringlist</var> <var>[[AppendFieldValues (Stringlist function)\|AppendFieldValues]]</var> function.</p>		<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for <var>$Field_List</var> is the <var>Stringlist</var> <var>[[AppendFieldValues (Stringlist function)\|AppendFieldValues]]</var> function.</p>

	This function retrieves field values from the current record into a [[$lists\|$list]]. It provides an alternative to <var>PAI INTO</var>.		This function retrieves field values from the current record into a [[$lists\|$list]]. It provides an alternative to <var>PAI INTO</var>.

JAL: misc cleanup

2015-03-09T16:11:13Z

misc cleanup

← Older revision		Revision as of 16:11, 9 March 2015
Line 103:		Line 103:
	<li>If a non-wildcard field name is specified for the <var class="term">fieldname</var> argument and the field name does not exist in the file, <var>$Field_List</var> simply returns a 0 without scanning the record. If a wildcard field name is specified for <var class="term">fieldname</var> and the wildcard string does not match any field names in the file, the record is still scanned. Except in the case of a non-wildcard field name that does not exist in the file or a request cancellation because of a truncated field name, or $list or CCATEMP full, the entire record is always scanned.		<li>If a non-wildcard field name is specified for the <var class="term">fieldname</var> argument and the field name does not exist in the file, <var>$Field_List</var> simply returns a 0 without scanning the record. If a wildcard field name is specified for <var class="term">fieldname</var> and the wildcard string does not match any field names in the file, the record is still scanned. Except in the case of a non-wildcard field name that does not exist in the file or a request cancellation because of a truncated field name, or $list or CCATEMP full, the entire record is always scanned.

	<li><var>$Field_List</var> is not recommended for use with <var>FILEORG</var> X'100' files~~; for~~ example, it will not create a $list item for an <var>EXACTLY-ONE</var> field ~~which~~ was not explicitly stored. For <var>FILEORG</var> X'100' files, <var>[[AppendFieldImages (Stringlist function)\|AppendFieldImages]]</var> (or the non-OO <var>[[$Field_ListI]]</var>) is recommended.		<li><var>$Field_List</var> is not recommended for use with <var>FILEORG</var> X'100' files. For example, <var>$Field_List</var> will not create a $list item for an <var>EXACTLY-ONE</var> field that was not explicitly stored. For <var>FILEORG</var> X'100' files, <var>[[AppendFieldImages (Stringlist function)\|AppendFieldImages]]</var> (or the non-OO <var>[[$Field_ListI]]</var>) is recommended.

	</ul>		</ul>

Dme: /* Usage notes */

2015-03-06T12:41:21Z

Usage notes

← Older revision		Revision as of 12:41, 6 March 2015
Line 102:		Line 102:

	<li>If a non-wildcard field name is specified for the <var class="term">fieldname</var> argument and the field name does not exist in the file, <var>$Field_List</var> simply returns a 0 without scanning the record. If a wildcard field name is specified for <var class="term">fieldname</var> and the wildcard string does not match any field names in the file, the record is still scanned. Except in the case of a non-wildcard field name that does not exist in the file or a request cancellation because of a truncated field name, or $list or CCATEMP full, the entire record is always scanned.		<li>If a non-wildcard field name is specified for the <var class="term">fieldname</var> argument and the field name does not exist in the file, <var>$Field_List</var> simply returns a 0 without scanning the record. If a wildcard field name is specified for <var class="term">fieldname</var> and the wildcard string does not match any field names in the file, the record is still scanned. Except in the case of a non-wildcard field name that does not exist in the file or a request cancellation because of a truncated field name, or $list or CCATEMP full, the entire record is always scanned.

			<li><var>$Field_List</var> is not recommended for use with <var>FILEORG</var> X'100' files; for example, it will not create a $list item for an <var>EXACTLY-ONE</var> field which was not explicitly stored. For <var>FILEORG</var> X'100' files, <var>[[AppendFieldImages (Stringlist function)\|AppendFieldImages]]</var> (or the non-OO <var>[[$Field_ListI]]</var>) is recommended.

	</ul>		</ul>

JAL: misc cleanup

2015-03-06T01:56:02Z

misc cleanup

← Older revision		Revision as of 01:56, 6 March 2015
Line 4:		Line 4:
	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for <var>$Field_List</var> is the <var>Stringlist</var> <var>[[AppendFieldValues (Stringlist function)\|AppendFieldValues]]</var> function.</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for <var>$Field_List</var> is the <var>Stringlist</var> <var>[[AppendFieldValues (Stringlist function)\|AppendFieldValues]]</var> function.</p>

	This function retrieves field values from the current record into a $list. It provides an alternative to <var>PAI INTO</var>.		This function retrieves field values from the current record into a [[$lists\|$list]]. It provides an alternative to <var>PAI INTO</var>.

	<var>$Field_List</var> accepts four arguments and returns a number indicating the success of the function.		<var>$Field_List</var> accepts four arguments and returns a number indicating the success of the function.
Line 19:		Line 19:
	<tr><th><var>>= 0</var> </th>		<tr><th><var>>= 0</var> </th>
	<td>Number of field values extracted </td></tr>		<td>Number of field values extracted </td></tr>

	<tr><th>    <var>-3</var></th>		<tr><th>    <var>-3</var></th>
	<td>CCATEMP full or $list full</td></tr>		<td>CCATEMP full or $list full</td></tr>
Line 54:		Line 55:

	===Output $list format===		===Output $list format===
	<table>		<table class="thJustBold">
	<tr><th>Offset</th>		<tr class="head"><th>Offset</th>
	<th>Contents</th>		<th>Contents</th>

	<tr><th>0-3</th>		<tr><th>0-3</th>
	<td>A binary sequence number (same as the $list item number when item added). </td></tr>		<td>A binary sequence number (same as the $list item number when item added). </td></tr>

	<tr><th>4-4</th>		<tr><th>4-4</th>
	<td>Binary length of field name (true or truncated depending on <var>TrueLen</var>). </td></tr>		<td>Binary length of field name (true or truncated depending on <var>TrueLen</var>). </td></tr>

	<tr><th>5-(5+N-1)</th>		<tr><th>5-(5+N-1)</th>
	<td>Blank padded or truncated field name where N is value of the <var class="term">fieldname_len</var> argument. </td></tr>		<td>Blank padded or truncated field name where N is value of the <var class="term">fieldname_len</var> argument. </td></tr>

	<tr><th>5+N-(5+N)</th>		<tr><th>5+N-(5+N)</th>
	<td>Binary length of field value. </td></tr>		<td>Binary length of field value. </td></tr>

	<tr><th>(5+N+1)-end</th>		<tr><th>(5+N+1)-end</th>
	<td>Field value in string format as it would be displayed in a <var>PAI</var>. </td></tr>		<td>Field value in string format as it would be displayed in a <var>PAI</var>. </td></tr>
Line 78:		Line 84:

	<li>The name specified in the <var class="term">fieldname</var> argument can be an explicit name, or it can contain the following wildcard characters:		<li>The name specified in the <var class="term">fieldname</var> argument can be an explicit name, or it can contain the following wildcard characters:
	<table class="~~syntaxTable~~">		<table class="thJustBold">
	<tr><th>*</th>		<tr><th>*</th>
	<td>Matches any number of characters including none</td></tr>		<td>Matches any number of characters including none</td></tr>

ELowell: /* Syntax terms */

2015-03-05T20:40:06Z

Syntax terms

← Older revision		Revision as of 20:40, 5 March 2015
Line 15:		Line 15:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%rc</th>		<tr><th>%rc</th>
	<td>A number of items added to <var class="term">olist</var>, ~~or it is~~ or it is one of these (negative) status codes:		<td>A number of items added to <var class="term">olist</var>, or it is one of these (negative) status codes:
	<table>		<table>
	<tr><th><var>>= 0</var> </th>		<tr><th><var>>= 0</var> </th>
Line 52:		Line 52:
	</td></tr></table>		</td></tr></table>
	</td></tr></table>		</td></tr></table>


	===Output $list format===		===Output $list format===

ELowell: /* Syntax */

2015-03-05T20:31:18Z

Syntax

← Older revision		Revision as of 20:31, 5 March 2015
Line 9:		Line 9:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Field_List</span>(<span class="term">olist, [fieldname_len], [fieldname], [options])		<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Field_List</span>(<span class="term">olist</span>, [<span class="term">fieldname_len</span>], [<span class="term">fieldname</span>], [<span class="term">options</span>])
	</p>		</p>

JALWiccan: Automatically generated page update

2013-07-18T20:36:13Z

Automatically generated page update

← Older revision		Revision as of 20:36, 18 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Return field values into a $list</span>		<span class="pageSubtitle">Return field values into a $list</span>

	<p class="~~warning~~">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for <var>$Field_List</var> is the <var>Stringlist</var> <var>[[AppendFieldValues (Stringlist function)\|AppendFieldValues]]</var> function.</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for <var>$Field_List</var> is the <var>Stringlist</var> <var>[[AppendFieldValues (Stringlist function)\|AppendFieldValues]]</var> function.</p>

	This function retrieves field values from the current record into a $list. It provides an alternative to <var>PAI INTO</var>.		This function retrieves field values from the current record into a $list. It provides an alternative to <var>PAI INTO</var>.

JALWiccan: Automatically generated page update

2013-04-12T19:56:04Z

Automatically generated page update

← Older revision		Revision as of 19:56, 12 April 2013
Line 9:		Line 9:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%rc</span> = $Field_List(olist, [fieldname_len], [fieldname], [options])		<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Field_List</span>(<span class="term">olist, [fieldname_len], [fieldname], [options])
	</p>		</p>

JALWiccan: Automatically generated page update

2013-04-12T15:11:10Z

Automatically generated page update

← Older revision		Revision as of 15:11, 12 April 2013
Line 9:		Line 9:

	==Syntax==		==Syntax==
	<p class="syntax">%rc = $Field_List(olist, [fieldname_len], [fieldname], [options])		<p class="syntax"><span class="term">%rc</span> = $Field_List(olist, [fieldname_len], [fieldname], [options])
	</p>		</p>

JALWiccan: Automatically generated page update

2013-04-10T18:16:49Z

Automatically generated page update

← Older revision		Revision as of 18:16, 10 April 2013
Line 9:		Line 9:

	==Syntax==		==Syntax==
	<p class="syntax"~~><section begin="syntax" /~~>%rc = $Field_List(olist, [fieldname_len], [fieldname], [options])		<p class="syntax">%rc = $Field_List(olist, [fieldname_len], [fieldname], [options])
	~~<section end="syntax" />~~</p>		</p>

	===Syntax terms===		===Syntax terms===