AppendFieldImages (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:Stringlist:AppendFieldImages subtitle}} | {{Template:Stringlist:AppendFieldImages subtitle}} | ||
This [[Notation conventions for methods#Callable functions|callable]] function retrieves fields that are in repeating groups into <var>Stringlist</var> items mapped to a < | This [[Notation conventions for methods#Callable functions|callable]] function retrieves fields that are in repeating groups into <var>Stringlist</var> items mapped to a <var class="product">User Language</var> image. | ||
<var>AppendFieldImages</var> is a <var>Stringlist</var> variant of <var>[[$Field_ListI]]</var>. <var>AppendFieldImages</var> has the same parameters as <var>$Field_listI</var>, except they are [[Notation conventions for methods#Named parameters|name required]] parameters. | |||
==Syntax== | ==Syntax== | ||
Revision as of 20:35, 6 July 2012
Add fields stored in image format to a Stringlist (Stringlist class)
[Introduced in Sirius Mods 7.8]
This callable function retrieves fields that are in repeating groups into Stringlist items mapped to a User Language image.
AppendFieldImages is a Stringlist variant of $Field_ListI. AppendFieldImages has the same parameters as $Field_listI, except they are name required parameters.
Syntax
[%count =] sl:AppendFieldImages[( [Image= string], [FirstOccurrence= number], - [MaxOccurrences= number], - [Options= string], [NullValue= string])]
Syntax terms
| %count | This numeric variable is the number of items (extracted repeating group occurrences) added to Stringlist sl, or it is a (negative) status code. |
|---|---|
| sl | A Stringlist object. |
| Image | string |
| FirstOccurrence | number |
| MaxOccurrences | number |
| Options | string |
| NullValue | string |
Usage notes
- For more information about images, see the User Language Manual.