History of putArrayString

== Syntax ==

int putArrayString(int nr, int index, string str)

== Arguments ==

:nr

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

:index

::The index/position number in the array where you want to store the string

:str

::The string value to be stored

== Return ==

Returns true / 1 if the string was stored successfully. Returns false / 0 if the array is out of range, not allocated, or if the string is too large to be stored in the array.

== Description ==

Stores a string into an element of one of the built-in arrays.

== Comment ==

Note that you must allocate space for the array first using the allocArray function, otherwise these functions will fail.

== Example ==

<code>

%ffp

ctl(0): combobox, "Harry\nJim\nSally",val=0,action=preview,size=(*,200)

OnFilterStart:{

// Allocate Array for storing 3 strings of max. 256 bytes length

allocArray(0,3,256,0,1);

// Store the Strings

putArrayString (0,0, "Hello, Harry!");

putArrayString (0,1, "Hello, Jimmy.");

putArrayString (0,2, "Hello, Sally, old girl!");

// Display

Info ("%s", getArrayString(0,ctl(0)) );

freeArray(0);

return false;

</code>

== See Also ==

allocArray, getArrayString, freeArray