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 | 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. | ||
==Syntax== | ==Syntax== | ||
| Line 8: | Line 8: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%count</th><td>number</td></tr> | <tr><th>%count</th> | ||
<td>This numeric variable is the number of items (extracted repeating group occurrences) added to <var>Stringlist</var> <var class="term">sl</var>, or it is a (negative) status code.</td></tr> | |||
<tr><th>sl</th> | <tr><th>sl</th> | ||
<td>Stringlist object</td></tr> | <td>A <var>Stringlist</var> object.</td></tr> | ||
<tr><th><var>Image</var></th> | <tr><th><var>Image</var></th> | ||
<td>string</td></tr> | <td>string</td></tr> | ||
<tr><th><var>FirstOccurrence</var></th> | <tr><th><var>FirstOccurrence</var></th> | ||
<td>number</td></tr> | <td>number</td></tr> | ||
<tr><th><var>MaxOccurrences</var></th> | <tr><th><var>MaxOccurrences</var></th> | ||
<td>number</td></tr> | <td>number</td></tr> | ||
<tr><th><var>Options</var></th> | <tr><th><var>Options</var></th> | ||
<td>string</td></tr> | <td>string</td></tr> | ||
<tr><th><var>NullValue</var></th> | <tr><th><var>NullValue</var></th> | ||
<td>string</td></tr> | <td>string</td></tr> | ||
| Line 24: | Line 31: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | |||
<li>For more information about images, see the <i>[http://http://www.rocketsoftware.com/m204/products/index/documentation/v7r4/M204-User-Language/view User Language Manual]</i>. | |||
</ul> | |||
==See also== | ==See also== | ||
{{Template:Stringlist:AppendFieldImages footer}} | {{Template:Stringlist:AppendFieldImages footer}} | ||
Revision as of 18:11, 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.
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.