alHeapCheck (function)

Checks the consistency of an N64 audio heap

Syntax

#include <libaudio.h>     /* libaudio.h */
s32 alHeapCheck(ALHeap *hp);

Arguments

hp
Pointer to the ALHeap structure to check

Description

In the debugging version of the libultra library (libultra_d), this function examines entries in the audio heap, represented by hp, to try to determine if the heap has been corrupted. If a heap corruption is detected, this function prints the file and line where the heap may have been corrupted and returns 1. Otherwise, it returns 0. It can not catch all corrupted heaps.

In the non-debug version of the library (libultra), alHeapCheck does nothing.

See Also

alHeapInit, alHeapAlloc

Revision History

1999/04/30 Changed Format