Next: GetArraySize - AurieFramework/YYToolkit GitHub Wiki

Gets the size of an GameMaker array.

Syntax

AurieStatus GetArraySize(
    [in]  RValue& Value,
    [out] size_t& Size
);

Parameters

Value

A non-const reference to a variable of type VALUE_ARRAY. You can get this reference to an existing variable by calling GetInstanceMember on an existing instance, or by creating a new RValue on the stack.

Size

A reference to a buffer into which the size of the array is written. If the function fails, the contents of this value are guaranteed to remain unchanged.

Return Value

The function returns AURIE_SUCCESS on success, otherwise returns a matching error code. If the information needed for looking up array elements isn't available, the AURIE_MODULE_INTERNAL_ERROR status code is returned. The function returns AURIE_INVALID_PARAMETER if the Value parameter isn't an array.