getarrval
getarrval |
Purpose
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