Initializing help system before first use

# getarrval

Purpose
Get the value of an array entry.
Synopsis
`int getarrval(XPRMarray array, const int indices[], void *adr);`
Arguments

array | Reference to an array
indices | n-tuple of indices where n is the number of dimensions of the array array
adr | Pointer to the area where the value of the array entry denoted by the index-tuple is returned.

Return value
0 if executed successfully, a positive value otherwise.
Further information
1. This function returns the value of an array entry that corresponds to a given tuple of indices for a given array. The address passed must reference an area large enough to receive data of the array's type: for instance, for an array of reals (type = XPRM_TYP_REAL) the adr parameter must be of type double*.
2. The returned value is 0 (integer, real or Boolean) or NULL (other types) if the requested entry does not exist when referencing a dynamic array.
Related topics
setarrval
Parent Topic Array access

© 2001-2026 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.