NNS_SndArcSetup

Syntax

#include <nnsys/snd.h>

BOOL NNS_SndArcSetup(
        NNSSndArc* arc,
        NNSSndHeapHandle heap,
        BOOL symbolLoadFlag );

Arguments

`arc`	Pointer to the sound archive structure.
`heap`	Sound heap handle.
`symbolLoadFlag`	Flag that determines whether to load symbol data.

Return Values

Returns a boolean value to indicate if the setup is successful.

Description

This function sets up the sound archive.

This function is called from the NNS_SndArcInit function. Normally, there is no need for you to call it.

Internally, this function loads data required to manage the sound archive. It allocates memory for holding management data from the sound heap specified by heap. The function will fail if it cannot allocate sufficient memory.

If the flag for whether to load symbol data, symbolLoadFlag, is set to TRUE, this function can use the NNS_SndArcGet*Symbol function to acquire symbol names. However, this consumes more of the sound heap heap.

Revision History