NNS_SndArcLoadWaveArc

C Specification

#include <nnsys/snd.h>
BOOL NNS_SndArcLoadWaveArc( int waveArcNo, NNSSndHeapHandle  heap );

Arguments

waveArcNo The waveform archive
heap The sound heap handle

Return Values

Returns a value to indicate whether or not the load was successful.

Description

Loads the waveform archive to the heap.

The memory necessary for loading is automatically allocated from the sound heap heap with the NNS_SndHeapAlloc function. If memory allocation fails, the process is interrupted and a FALSE is returned.

Sound data that is already resident in memory is not loaded. Execution of the function NNS_SndArcGetFileAddress will determine whether or not the sound data is resident in memory. Also, the NNS_SndArcSetFileAddress function sets the address of the successfully loaded data.

Note

Use this function only for the sound archive initialized with the NNS_SndArcInit function. This function cannot be used with the sound archive initialized with the NNS_SndArcInitOnMemory function.

See Also

NNS_SndHeapAlloc, NNS_SndArcGetFileAddress, NNS_SndArcSetFileAddress, NNS_SndArcInit, NNS_SndArcInitOnMemory

Revision History

06/01/2004 Initial version.