AppendFieldValues (Stringlist function) - Revision history

ELowell at 22:48, 2 September 2015

2015-09-02T22:48:33Z

← Older revision		Revision as of 22:48, 2 September 2015
Line 1:		Line 1:
	{{Template:Stringlist:AppendFieldValues subtitle}}		{{Template:Stringlist:AppendFieldValues subtitle}}

	This [[Notation conventions for methods#Callable functions\|callable]] function retrieves retrieves field values from the current record into <var>Stringlist</var> items.		This [[Notation conventions for methods#Callable functions\|callable]] function retrieves retrieves field values from the current record into <var>Stringlist</var> items.

JAL: misc cleanup

2015-03-09T16:07:11Z

misc cleanup

← Older revision		Revision as of 16:07, 9 March 2015
Line 101:		Line 101:
	<li>If a non-wildcard <var>Fieldname</var> value is specified, and the field name does not exist in the file, <var>AppendFieldValues</var> simply returns a 0 without scanning the record. If a wildcard <var>Fieldname</var> value is specified 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 <var>Fieldname</var> value that does not exist in the file, or a request cancellation because of a truncated field name, or <var>Stringlist</var> or CCATEMP full, the entire record is always scanned.		<li>If a non-wildcard <var>Fieldname</var> value is specified, and the field name does not exist in the file, <var>AppendFieldValues</var> simply returns a 0 without scanning the record. If a wildcard <var>Fieldname</var> value is specified 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 <var>Fieldname</var> value that does not exist in the file, or a request cancellation because of a truncated field name, or <var>Stringlist</var> or CCATEMP full, the entire record is always scanned.

	<li><var>AppendFieldValues</var> is not recommended for use with <var>FILEORG</var> X'100' files~~; for~~ example, it will not create a Stringlist 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> is recommended.		<li><var>AppendFieldValues</var> is not recommended for use with <var>FILEORG</var> X'100' files. For example, <var>AppendFieldValues</var> will not create a <var>Stringlist</var> 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> is recommended.

	</ul>		</ul>

Dme: /* Usage notes */

2015-03-06T12:37:20Z

Usage notes

← Older revision		Revision as of 12:37, 6 March 2015
Line 99:		Line 99:
	</ul>		</ul>

	<li>If a non-wildcard <var>Fieldname</var> value is specified, and the field name does not exist in the file, <var>AppendFieldValues</var> simply returns a 0 without scanning the record. If a wildcard <var>Fieldname</var> value is specified 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 <var>Fieldname</var> value that does not exist in the file, or a request cancellation because of a truncated field name, or <var>Stringlist</var> or CCATEMP full, the entire record is always scanned.		<li>If a non-wildcard <var>Fieldname</var> value is specified, and the field name does not exist in the file, <var>AppendFieldValues</var> simply returns a 0 without scanning the record. If a wildcard <var>Fieldname</var> value is specified 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 <var>Fieldname</var> value that does not exist in the file, or a request cancellation because of a truncated field name, or <var>Stringlist</var> or CCATEMP full, the entire record is always scanned.

			<li><var>AppendFieldValues</var> is not recommended for use with <var>FILEORG</var> X'100' files; for example, it will not create a Stringlist 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> is recommended.

	</ul>		</ul>

JAL: misc cleanup

2015-03-06T02:00:15Z

misc cleanup

← Older revision		Revision as of 02:00, 6 March 2015
Line 51:		Line 51:

	===Output Stringlist item format===		===Output Stringlist item 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>NameLength</var> argument. </td></tr>		<td>Blank padded or truncated field name, where N is value of the <var>NameLength</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 75:		Line 80:

	<li>The name specified in the <var>Fieldname</var> argument can be an explicit name, or it can contain the following wildcard characters:		<li>The name specified in the <var>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>

	<tr><th>?</th>		<tr><th>?</th>
	<td>Matches any single character</td></tr>		<td>Matches any single character</td></tr>

	<tr><th>"</th>		<tr><th>"</th>
	<td>Indicates that the next character must be treated literally even if it is a wildcard character.		<td>Indicates that the next character must be treated literally even if it is a wildcard character.
Line 106:		Line 113:
	==See also==		==See also==
	<ul>		<ul>
	<li><var>[[AppendFieldImages (Stringlist function)\|AppendFieldImages]]</var> retrieves fields that are in repeating groups into <var>Stringlist</var> items mapped to a <var class="product">~~User Language~~</var> image.		<li><var>[[AppendFieldImages (Stringlist function)\|AppendFieldImages]]</var> retrieves fields that are in repeating groups into <var>Stringlist</var> items mapped to a <var class="product">SOUL</var> image.
	</ul>		</ul>
	{{Template:Stringlist:AppendFieldValues footer}}		{{Template:Stringlist:AppendFieldValues footer}}

Admin: /* See also */

2012-10-10T19:59:11Z

Dme: /* See also */

2012-08-12T16:31:00Z

JAL2: /* Examples */

2012-07-10T16:28:46Z

Examples

← Older revision		Revision as of 16:28, 10 July 2012
Line 96:		Line 96:

	==Examples==		==Examples==
	The following code fragment retrieves all fields in a record where the field name begins with the letters "CHILD_" into <var>Stringlist</var> <code>%sl</code> and sorts the <var>Stringlist</var> by field name:		The following code fragment retrieves all fields in a record where the field name begins with the letters "CHILD_" into <var>Stringlist</var> <code>%sl</code> and sorts the <var>Stringlist</var> <code>%sl</code> by field name into <var>Stringlist</var> <code>%outlist</code>:
	<p class="code">In File INFILE Frn %recno		<p class="code">In File INFILE Frn %recno
	%rc = %sl:AppendFieldValues('CHILD_*', 20)		%rc = %sl:AppendFieldValues('CHILD_*', 20)

JAL2 at 16:27, 10 July 2012

2012-07-10T16:27:02Z

← Older revision		Revision as of 16:27, 10 July 2012
Line 24:		Line 24:

	<tr><th><var>NameLength</var></th>		<tr><th><var>NameLength</var></th>
	<td>This optional, [[Notation conventions for methods#Named parameters\|name required]], argument is a string containing the length of the output ~~fieldname~~ in the output ~~<var>~~Stringlist~~</var>~~ items. It can be any numeric value from 0 to 255; the default is 255.</td></tr>		<td>This optional, [[Notation conventions for methods#Named parameters\|name required]], argument is a string containing the length of the output field name in the [[#Output Stringlist item format\|output Stringlist items]]. It can be any numeric value from 0 to 255; the default is 255.</td></tr>

	<tr><th><var>Fieldname</var></th>		<tr><th><var>Fieldname</var></th>
	<td>An optional, name required, string that is the name of the field to be returned. This argument can contain a single specific ~~fieldname~~ or it can contain a wildcard string that matches a number of fields in the file. The default is an asterisk (<tt>*</tt>), which means to return all fields in the record.</td></tr>		<td>An optional, name required, string that is the name of the field to be returned. This argument can contain a single specific field name or it can contain a wildcard string that matches a number of fields in the file. The default is an asterisk (<tt>*</tt>), which means to return all fields in the record.</td></tr>

	<tr><th><var>Options</var></th>		<tr><th><var>Options</var></th>
Line 33:		Line 33:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th><var>TruncLeft</var></th>		<tr><th><var>TruncLeft</var></th>
	<td>Truncate ~~fieldnames~~ on the left. This is mutually exclusive with the <var>TruncRight</var> and <var>CanTrunc</var> options.</td></tr>		<td>Truncate field names on the left. This is mutually exclusive with the <var>TruncRight</var> and <var>CanTrunc</var> options.</td></tr>

	<tr><th><var>TruncRight</var></th>		<tr><th><var>TruncRight</var></th>
	<td>Truncate ~~fieldnames~~ on the right. This is mutually exclusive with the <var>TruncLeft</var> and <var>CanTrunc</var> options.</td></tr>		<td>Truncate field names on the right. This is mutually exclusive with the <var>TruncLeft</var> and <var>CanTrunc</var> options.</td></tr>

	<tr><th><var>CanTrunc</var></th>		<tr><th><var>CanTrunc</var></th>
	<td>Cancel request on truncated ~~fieldname~~, except when the <var>NameLength</var> argument is 0. This is mutually exclusive with the <var>TruncRight</var> and <var>TruncLeft</var> options.</td></tr>		<td>Cancel request on truncated field name, except when the <var>NameLength</var> argument is 0. This is mutually exclusive with the <var>TruncRight</var> and <var>TruncLeft</var> options.</td></tr>

	<tr><th><var>TrueLen</var></th>		<tr><th><var>TrueLen</var></th>
	<td>Set true ~~fieldname~~ length rather than truncated ~~fieldname~~ length in the ~~fieldname~~ length byte in the output <var>Stringlist</var>. This is mutually exclusive with the <var>TruncLen</var> option.</td></tr>		<td>Set true field-name length rather than truncated field-name length in the field-name length byte in the output <var>Stringlist</var>. This is mutually exclusive with the <var>TruncLen</var> option.</td></tr>

	<tr><th><var>TruncLen</var></th>		<tr><th><var>TruncLen</var></th>
	<td>Set truncated ~~fieldname~~ length in the ~~fieldname~~ length byte in the output <var>Stringlist</var>; this is the default. This is mutually exclusive with the <var>TrueLen</var> option.		<td>Set truncated field-name length in the field-name length byte in the output <var>Stringlist</var>; this is the default. This is mutually exclusive with the <var>TrueLen</var> option.
	</td></tr></table>		</td></tr></table>
	</td></tr>		</td></tr>
Line 57:		Line 57:
	<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 ~~fieldname~~ (true or truncated depending on TrueLen). </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 argument 2. </td></tr>		<td>Blank padded or truncated field name, where N is value of the <var>NameLength</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 PAI. </td></tr>		<td>Field value in string format as it would be displayed in a <var>PAI</var>. </td></tr>
	</table>		</table>

Line 101:		Line 101:
	End For		End For

	%outlist = %sl:~~Sort~~('6,20,A')		%outlist = %sl:Sortnew('6,20,A')
	</p>		</p>

	==See also==		==See also==
	{{Template:Stringlist:AppendFieldValues footer}}		{{Template:Stringlist:AppendFieldValues footer}}

JAL2 at 22:14, 9 July 2012

2012-07-09T22:14:42Z

@@ Line 1: / Line 1: @@
 {{Template:Stringlist:AppendFieldValues subtitle}}
-This page is [[under construction]].
+This [[Notation conventions for methods#Callable functions|callable]] function retrieves retrieves field values from the current record into <var>Stringlist</var> items.
 ==Syntax==
 {{Template:Stringlist:AppendFieldValues syntax}}
 ===Syntax terms===
 <table class="syntaxTable">
-<tr><th>%count</th><td>number</td></tr>
+<tr><th>%count</th>
 <tr><th>sl</th>
-<td>Stringlist object</td></tr>
+<td>A <var>Stringlist</var> object. If empty, data is added to the end of the <var>Stringlist</var>.</td></tr>
 <tr><th><var>NameLength</var></th>
-<td>number</td></tr>
+<td>This optional, [[Notation conventions for methods#Named parameters|name required]], argument is a string containing the length of the output fieldname in the output <var>Stringlist</var> items. It can be any numeric value from 0 to 255; the default is 255.</td></tr>
 <tr><th><var>Fieldname</var></th>
-<td>string</td></tr>
+<td>An optional, name required, string that is the name of the field to be returned. This argument can contain a single specific fieldname or it can contain a wildcard string that matches a number of fields in the file. The default is an asterisk (<tt>*</tt>), which means to return all fields in the record.</td></tr>
 <tr><th><var>Options</var></th>
-<td>string</td></tr>
+<td>An optional, name required, string that is a set of blank-delimited processing options. As of <var class="Product">Sirius Mods</var> Version 7.1, these options may be specified in any combination of uppercase and lowercase letters (prior to that, all-uppercase letters are required):
 </table>
 ==Usage notes==
 ==Examples==
 ==See also==
 {{Template:Stringlist:AppendFieldValues footer}}

JALWiccan: Automatically generated page update

2012-06-26T18:07:32Z

Automatically generated page update

New page

{{Template:Stringlist:AppendFieldValues subtitle}}

This page is [[under construction]].
==Syntax==
{{Template:Stringlist:AppendFieldValues syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%count</th><td>number</td></tr>
<tr><th>sl</th>
<td>Stringlist object</td></tr>
<tr><th><var>NameLength</var></th>
<td>number</td></tr>
<tr><th><var>Fieldname</var></th>
<td>string</td></tr>
<tr><th><var>Options</var></th>
<td>string</td></tr>
</table>
==Usage notes==
==Examples==
==See also==
{{Template:Stringlist:AppendFieldValues footer}}

← Older revision		Revision as of 19:59, 10 October 2012
Line 106:		Line 106:
	==See also==		==See also==
	<ul>		<ul>
	<li><var>[[AppendFieldImages (Stringlist function)\|AppendFieldImages]]</var> retrieves fields that are in repeating groups into <var>Stringlist</var> items mapped to a User Language image.		<li><var>[[AppendFieldImages (Stringlist function)\|AppendFieldImages]]</var> retrieves fields that are in repeating groups into <var>Stringlist</var> items mapped to a <var class="product">User Language</var> image.
	</ul>		</ul>
	{{Template:Stringlist:AppendFieldValues footer}}		{{Template:Stringlist:AppendFieldValues footer}}

← Older revision		Revision as of 16:31, 12 August 2012
Line 105:		Line 105:

	==See also==		==See also==
			<ul>
			<li><var>[[AppendFieldImages (Stringlist function)\|AppendFieldImages]]</var> retrieves fields that are in repeating groups into <var>Stringlist</var> items mapped to a User Language image.
			</ul>
	{{Template:Stringlist:AppendFieldValues footer}}		{{Template:Stringlist:AppendFieldValues footer}}