.TH alHeapCheck 3P local "Silicon Graphics, Inc."

.SH NAME
.upperok
alHeapCheck \- check the consistency of an Ultra 64 audio heap.

.SH SYNOPSIS
.nf
\f3
.Op c
#include <libaudio.h>
.sp .8v
s32     alHeapCheck(ALHeap *hp);
.Op
\f1
.fi
.SH PARAMETERS
.TP 10
.I hp
pointer to the ALHeap structure to check.
.SH DESCRIPTION
In the debugging version of libultra (libultra_d), 
.I alHeapCheck
examines entries in the audio heap, represented by
.I hp,
to try to determine if the heap has been corrupted. If it detects a
heap corruption, it prints the file and line where the heap MAY have
been corrupted and returns 1. Otherwise, it returns 0. It may not
catch all corrupted heaps.

In the non-debug version (libultra), 
.I alHeapCheck
does nothing.
.SH SEE ALSO
.IR alHeapInit (3P),
.IR alHeapAlloc (3P)