Next: GetNamedRoutineIndex

Looks up a named object in various runner data structures.

Syntax

AurieStatus GetNamedRoutineIndex(
    [in]  const char* FunctionName,
    [out] int*        FunctionIndex
);

Parameters

FunctionName

A pointer to the buffer containing the name of the object to look up. This parameter can refer to either a GameMaker built-in function, a GameMaker script, or a function name provided by extensions. Note that this function is case-sensitive, and therefore a script named scr_my_Script is different from a script named scr_my_script. This behavior is consistent for all types of lookups.

FunctionIndex

A pointer to an 32-bit integer, which receives the index of the object being looked up. This pointer is only written to if and when the function succeeds. If the function fails, the contents of the pointed-to variable are guaranteed to remain untouched.

Return Value

The function returns AURIE_SUCCESS on success, otherwise returns a matching error code. If the internal runner function needed for looking up named objects isn't available, the AURIE_MODULE_INTERNAL_ERROR status code is returned. The function returns AURIE_OBJECT_NOT_FOUND if the lookup failed.