Array Functions

• Source: https://www.freebasic.net/wiki/wikka.php?wakka=CatPgArray
• Last revised: 2022-08-20

---

Statements and procedures for working with arrays.

Defining Arrays Statements that create arrays.

Clearing Array Data Procedures that work with array memory.

Retrieving Array Size Procedures that return the array's length/size and bounds for any array's dimension.

Retrieving Array Descriptor Procedures that return a pointers to an array's descriptor.

Defining Arrays

OPTION DYNAMIC

Forces arrays to be defined as variable-length arrays.

'$DYNAMIC

Alternate form of the OPTION DYNAMIC statement.

OPTION STATIC

Reverts a previous OPTION DYNAMIC command.

'$STATIC

Alternate form of the OPTION STATIC statement.

DIM

Defines any type of array.

REDIM

Defines and resizes variable-length arrays.

PRESERVE

Preserves array contents when used with REDIM.

Clearing Array Data

ERASE

Destroys variable-length array elements and initializes fixed-length array elements.

Retrieving Array Size

ARRAYLEN

Returns the total number of array elements.

ARRAYSIZE

Returns the total array size (in bytes).

LBOUND

Returns the lower bound of an array's dimension.

UBOUND

Returns the upper bound of an array's dimension.

Retrieving Array Descriptor

Array[Const]DescriptorPtr

Returns a [constant] pointer to array's descriptor (FBARRAY).

Back to DocToc