$Arr Init: Difference between revisions
Jump to navigation
Jump to search
(→Syntax) |
m (add italics) |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle">Initialize every element of an array to specific value</span> | <span class="pageSubtitle">Initialize every element of an array to specific value</span> | ||
<p class="warn"><b>Note: </b> | <p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for <var>$Arr_Init</var>, because the OO methods emphasize the use of [[Collections]] over the use of arrays.</p> | ||
<var>$Arr_Init</var> can be used to initialize every element of an [[ | <var>$Arr_Init</var> can be used to initialize every element of an [[Using variables and values in computation#Variable arrays|array]] to a specific value. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><span class="term">%result</span> = $Arr_Init (array, value) | <p class="syntax"><span class="term">%result</span> = $Arr_Init (<span class="term">array, value</span>) | ||
</p> | </p> | ||
< | <table> | ||
<tr><th>%result</th> | |||
<td>A numeric value that receives a 0 or, if the array is invalid, a -1. | |||
</td></tr> | |||
<tr><th>array</th> | |||
<td>An array of string, float, or fixed values. This array can be a single or multi-dimensional array and must not be an array in an image. | |||
For string array elements the value assigned | <tr><th>value</th> | ||
<td>The value with which the array is to be initialized. If this argument is not specified, it defaults to a null string if the first argument is a string array, or it defaults to 0 if the first argument is a fixed or float array. | |||
<p> | |||
For string array elements, the value assigned is truncated if the value is longer than the element length. </p></td></tr> | |||
</table> | |||
==Examples== | ==Examples== | ||
<ol> | <ol> | ||
<li>In the following example, every element of % | <li>In the following example, every element of <code>%fxarray</code> is set to 0: | ||
<p class="code">% | <p class="code">%fxarray is fixed array(5) | ||
% | %rc = $Arr_Init(%fxarray) | ||
</p> | </p> | ||
<li>In the following example, every element of % | <li>In the following example, every element of <code>%starray</code> is set to <code>*** UNKNOWN ***</code>: | ||
<p class="code">% | <p class="code">%starray is string len 20 array(5) | ||
% | %rc = $Arr_Init(%starray, '*** UNKNOWN ***') | ||
</p></ol> | </p></ol> | ||
Latest revision as of 16:08, 8 January 2018
Initialize every element of an array to specific value
Note: Many $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for $Arr_Init, because the OO methods emphasize the use of Collections over the use of arrays.
$Arr_Init can be used to initialize every element of an array to a specific value.
Syntax
%result = $Arr_Init (array, value)
| %result | A numeric value that receives a 0 or, if the array is invalid, a -1. |
|---|---|
| array | An array of string, float, or fixed values. This array can be a single or multi-dimensional array and must not be an array in an image. |
| value | The value with which the array is to be initialized. If this argument is not specified, it defaults to a null string if the first argument is a string array, or it defaults to 0 if the first argument is a fixed or float array.
For string array elements, the value assigned is truncated if the value is longer than the element length. |
Examples
- In the following example, every element of
%fxarrayis set to 0:%fxarray is fixed array(5) %rc = $Arr_Init(%fxarray)
- In the following example, every element of
%starrayis set to*** UNKNOWN ***:%starray is string len 20 array(5) %rc = $Arr_Init(%starray, '*** UNKNOWN ***')