Next: GetBuiltinVariableInformation - AurieFramework/YYToolkit GitHub Wiki

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

Value	Description
AURIE_SUCCESS	The variable information was written into the buffer.
AURIE_MODULE_INTERNAL_ERROR	The internal function needed is unavailable.
AURIE_INVALID_PARAMETER	An out-of-bounds read was attempted.

Requirements

Criterium	Value
Minimum YYTK Version	3.0.3
Context	Any