Older Newer
Fri, 20 Dec 2019 13:21:04 . . . . SyneRyder [Initial function definition]


Changes by last author:

Added:
= __fgetArray =

== Syntax ==

double __fgetArray(int nr, int x, int y, int z)

== Arguments ==

:nr

::Number of the array. Values from 0 to 99 are accepted.

:x, y, z

::x, y, and z coordinates of a cell in the array. If you allocated a one-dimensional array, set y and z to zero. If you allocated a two-dimensional array, set z to zero.

== Return ==

Returns the double floating-point value that was stored at the specified coordinates in the array. Warning: If the specified coordinates lie outside the array, the plug-in may crash.

== Description ==

This function lets you read a floating-point value from an array. This is a fast version of fgetArray without any error checking or memory checking. As it does not do any border checking, it may produce error messages or even crashes if not used properly.

== Example ==

See allocArray for an example of how to allocate arrays and use the similar fgetArray function.

== See Also ==

__getArray, __fputArray, allocArray, freeArray, putArray, getArrayDim, copyArray