Next: GetInstanceObject

Converts an instance ID to an instance object.

Syntax

AurieStatus GetInstanceObject(
    [in]  int32_t     InstanceID,
    [out] CInstance*& Instance
);

Parameters

InstanceID

The ID of a currently active instance. This ID can be found in either the instance_id global built-in array, and is returned from functions such as instance_create_depth.

Instance

A reference to a pointer-sized buffer, into which the pointer to the instance is written. This pointer is guaranteed to remain valid until the instance is destroyed. If the function fails, the contents of this buffer are guaranteed to remain unchanged.

Return Value

Value	Description
AURIE_SUCCESS	The instance was found, and the pointer to it was written into the buffer.
AURIE_MODULE_INTERNAL_ERROR	The internal function needed is unavailable.
AURIE_OBJECT_NOT_FOUND	The instance does not exist.

Requirements

Criterium	Value
Minimum YYTK Version	3.1.3
Context	Engine-synchronous