Initializing help system before first use

getarrval

Purpose
Get the value of a cell of an array.
Synopsis
function getarrval(arr:array, val:any, ...):reflecterror
function getarrval(arr:array, val:any, lsndx:list):reflecterror
Arguments
arr 
An array or a union containg an array
val 
A union reference where the value will be returned
lsndx 
List of indices to use
Return value
The error status as a reflecterror
Further information
1. The procedure will use the arguments after val as the list of indices to use (that can be an iterator) or take the provided list lsndx if it is the only argument.
2. Thanks to this procedure it is possible to retrieve the value of an array cell without knowing its type. However, it is more efficient to dereference the array directly when the type is known ( e.g. un.array(1).integer).
3. The execution status of the function is notified via its return value. If this value is ignored ( i.e. the function is used as a procedure) the execution of the model will be interrupted in case of error ( e.g. invalid number or type of indices).
Related topics
setarrval.
Module
mmreflect

Parent Topic Procedures and functions

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.