Next: GetCurrentRoomData

Gets the currently active room object (Run_Room).

Syntax

AurieStatus GetCurrentRoomData(
    [out] CRoom*& Room
);

Parameters

Room

A reference to a pointer-sized buffer into which the address of the CRoom object is written. If the function fails, the buffer referenced by this parameter is left untouched. In the name of safety, this structure is normally opaque. To remove this safeguard, see Enabling internal structure access. The pointer written into this buffer is guaranteed to remain valid for the duration of the room being active.

Return Value

The function returns AURIE_SUCCESS on success, otherwise returns a matching error code. If the information needed for looking up the current room isn't available, the function returns AURIE_MODULE_INTERNAL_ERROR.