Next: GetBuiltinVariableInformation

Retrieves the engine entry for a built-in variable.

Syntax

AurieStatus GetBuiltinVariableInformation(
    [in]  size_t             Index,
    [out] RVariableRoutine*& VariableInformation
);

Parameters

Index

The array index of the built-in variable. This index can be obtained by calling GetBuiltinVariableIndex.

VariableInformation

A reference to a pointer-sized buffer which receives the address of the array entry for the built-in variable. You may keep a pointer to this struct, as it should be resident in memory until the runner exits. Even though the structure fields are writable, plugins should treat this structure as read-only for increased safety.

Return Value

On success, the function returns AURIE_SUCCESS and writes the pointer to the array element into the VariableInformation buffer. If the function fails, it returns a matching error code. If the internal variable lookup facilities aren't available, the function returns AURIE_MODULE_INTERNAL_ERROR. If the index accessed is larger than the number of currently used variables, the function returns AURIE_INVALID_PARAMETER, preventing an out-of-bounds read.