Older Newer
Sun, 26 Dec 2021 06:51:14 . . . . SyneRyder [Note minimum FM version requirement]


Changes by last author:

Added:
= fputArray =

Requires FM 1.0 Beta 9.0 (Apr 2008) or newer

== Syntax ==

:int fputArray (int nr, int x, int y, int z, double dval)

== Arguments ==

:nr

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

: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.

:dval

::Floating-point value that will be stored at the specified coordinates in the array.

== Return ==

:Returns 0 for failure (invalid index nr, or invalid byte-size of Array), and 1 for success.

== Description ==

:Lets you store a floating-point value in an array. When storing a value into an Array with byte-size 2, the value will be converted to a 16-bit (half)?. For an Array of byte-size 4, the value is converted to a 32-bit (float)?. If the byte-size is not 2, 4, or 8, a value of 0 is returned to indicate failure.)

== Example ==

:See fgetArray

== Also see ==

:allocArray, freeArray, getArray, fgetArray, putArray, fillArray, ffillArray, getArrayDim, copyArray

== Comments ==

:Everyone can add his comments about his experiences with this function here. Tips for using it are welcome, too.