AddImage (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| (24 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Stringlist:AddImage subtitle}} | {{Template:Stringlist:AddImage subtitle}} | ||
This callable method copies data from an image to a <var>Stringlist</var>. The AddImage method accepts one argument and returns a numeric result. | This [[Notation conventions for methods#Callable functions|callable]] method copies data from an image to a <var>Stringlist</var>. The <var>AddImage</var> method accepts one argument and returns a numeric result. | ||
==Syntax== | ==Syntax== | ||
| Line 8: | Line 8: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%number</th> | <tr><th>%number</th> | ||
<td>A numeric variable to contain the number of items in the indicated <var>Stringlist</var> after the string has been added to the <var>Stringlist</var>. | <td>A numeric variable to contain the number of items in the indicated <var>Stringlist</var> after the string has been added to the <var>Stringlist</var>. <var class="term">%number</var> is also the item number associated with the added string in the <var>Stringlist</var>.</td></tr> | ||
<tr><th>sl</th> | <tr><th>sl</th> | ||
<td>A <var>Stringlist</var> object.</td></tr> | <td>A <var>Stringlist</var> object.</td></tr> | ||
<tr><th>imageName</th> | <tr><th>imageName</th> | ||
<td>A string that contains the name of an image or of any image item from the required image. This argument is optional if an image has been associated with the <var>Stringlist</var> by a [[BindImage (Stringlist function)]]. Otherwise, it is a required argument.</td></tr> | <td>A string that contains the name of an image or of any image item from the required image. This argument is optional if an image has been associated with the <var>Stringlist</var> by a <var>[[BindImage (Stringlist function)|BindImage]]</var>. Otherwise, it is a required argument.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul><li>All errors result in request cancellation.</ul> | |||
All errors result in request cancellation. | |||
==Examples== | ==Examples== | ||
The following example demonstrates how AddImage might be used: | <ol><li>The following example demonstrates how <var>AddImage</var> might be used: | ||
< | <p class="code">image cust | ||
image cust | name is string len 20 | ||
name is string len 20 | ssn is string len 10 | ||
ssn is string len 10 | bdate is string len 8 | ||
bdate is string len 8 | |||
end image | end image | ||
... | ... | ||
find records to %recset | find records to %recset | ||
name = smith | name = smith | ||
end find | end find | ||
... | ... | ||
| Line 37: | Line 35: | ||
for each record in %recset | for each record in %recset | ||
%cust:name = name | %cust:name = name | ||
%cust:ssn = ssn | %cust:ssn = ssn | ||
%cust:bdate = bdate | %cust:bdate = bdate | ||
%count = %list:addImage('CUST') | %count = %list:addImage('CUST') | ||
end for | end for | ||
</ | </p> | ||
<li>A more efficient way of coding the <var>For Each Record</var> loop is: | |||
A more efficient way of coding the For Each Record | <p class="code">%list:bindImage('CUST') | ||
< | |||
%list:bindImage('CUST') | |||
for each record in %recset | for each record in %recset | ||
%cust:name = name | %cust:name = name | ||
%cust:ssn = ssn | %cust:ssn = ssn | ||
%cust:bdate = bdate | %cust:bdate = bdate | ||
%count = %list:addImage | %count = %list:addImage | ||
end for | end for | ||
</ | </p> | ||
In this last example, the <var>[[BindImage (Stringlist function)|BindImage]]</var> associates the image with the <var>Stringlist</var>, eliminating the need to specify the image name on the <var>AddImage</var> invocation.</ol> | |||
In this last example, the [[BindImage (Stringlist function)]] associates the image with the <var>Stringlist</var>, eliminating the need to specify the image name on the AddImage invocation. | |||
==See also== | |||
{{Template:Stringlist:AddImage footer}} | |||
Latest revision as of 19:40, 14 July 2011
Add image as new Stringlist item (Stringlist class)
This callable method copies data from an image to a Stringlist. The AddImage method accepts one argument and returns a numeric result.
Syntax
[%number =] sl:AddImage[( [imageName])]
Syntax terms
| %number | A numeric variable to contain the number of items in the indicated Stringlist after the string has been added to the Stringlist. %number is also the item number associated with the added string in the Stringlist. |
|---|---|
| sl | A Stringlist object. |
| imageName | A string that contains the name of an image or of any image item from the required image. This argument is optional if an image has been associated with the Stringlist by a BindImage. Otherwise, it is a required argument. |
Usage notes
- All errors result in request cancellation.
Examples
- The following example demonstrates how AddImage might be used:
image cust name is string len 20 ssn is string len 10 bdate is string len 8 end image ... find records to %recset name = smith end find ... %list is object stringList %list = new for each record in %recset %cust:name = name %cust:ssn = ssn %cust:bdate = bdate %count = %list:addImage('CUST') end for
- A more efficient way of coding the For Each Record loop is:
%list:bindImage('CUST') for each record in %recset %cust:name = name %cust:ssn = ssn %cust:bdate = bdate %count = %list:addImage end for
In this last example, the BindImage associates the image with the Stringlist, eliminating the need to specify the image name on the AddImage invocation.