View source for $VALIDATE NUMERIC DATA

{{DISPLAYTITLE:$VALIDATE_NUMERIC_DATA}}
<b>Function</b>
<p>Detects invalid numeric data when data is read into an image from an external source. </p>
<b>Syntax</b>
<p class="code">$VALIDATE_NUMERIC_DATA('%variable' 

  | '%imagename:itemname', s1, s2, s3, s4, s5)
</p>
<p>Where:</p>
<ul>
<li>%variable is a string expression enclosed in single quotation marks that resolves to the name of an item in an image. The value of this string is the standard format for referencing an image item: %imagename:itemname, which is also enclosed in single quotation marks.</li>
</li>
<li>If the argument identifies an array item, up to five subscripts can be used, s1-s5. If an array is not specified, these arguments are ignored. On an array, as many of these parameters are used as the number of dimensions on the array. If any needed subscript parameter is not specified, then a value of 1 is used.</li>
</li>
</ul>
<b>Example</b>
<p>If %imagename:itemname identifies an array, then you must identify the particular array element to validate. To do so, note the number of subscripts of the array, and specify the same number of optional subscript arguments (the s1-s5 arguments). For example, to validate %IMAGE:ARRAY(1,2), code </p>
<p class="code">%RC=$VALIDATE_NUMERIC_DATA('%IMAGE:ARRAY',1,2)
</p>
<b>Usage</b>
<p>The image item whose name is passed is looked up in the image definition. </p>
<ul>
<li>If the item is a numeric type, the contents of the data area of the image are checked to see if the data that corresponds to the item is in the correct format. </li>
</li>
<li>If the item is an array, the element identified by the subscripts is tested.</li>
</li>
</ul>
<p>The numeric return code values have the following meanings:</p>
<table>
<tr class="head">
<th>Return code </th>
<th>Means... </th>
</tr>
<tr>
<td align="right">0 </td>
<td>Return code zero indicates good data. Either item is numeric and the data is of the correct format, or the item is not numeric (no validation performed).</td>
</tr>
<tr>
<td align="right">1</td>
<td>Item is numeric and the data is invalid.</td>
</tr>
<tr>
<td align="right">2 </td>
<td>On an array element, at least one subscript is out-of-bounds.</td>
</tr>
<tr>
<td align="right">3 </td>
<td>Item named does not exist.</td>
</tr>
</table>
[[Category:SOUL $functions]]