SND_GetNextInstData

Syntax

#include <nitro/snd.h>

BOOL SND_GetNextInstData(
        const SNDBankData* bank,
        SNDInstData* inst,
        SNDInstPos* pos );

Arguments

`bank`	This is the bank data pointer.
`inst`	This is the pointer to the structure that stores the obtained instrument data.
`pos`	This is the instrument data positional information.

Return Values

Returns TRUE if the instrument data is successfully obtained. Returns FALSE if the next instrument data does not exist.

Description

Gets the instrument data in the bank data in order.

If the instrument data is successfully obtained, this function writes SNDInstData-type instrument data to the memory region designated with inst. Furthermore, pos, which indicates the instrument data positional information, is updated so that it indicates the position of the next instrument data.

When first calling this function, you must pass the instrument data's position, obtained with the SND_GetFirstInstDataPos function, to pos.

    SNDInstPos pos = SND_GetFirstInstDataPos( bank );
    SNDInstData inst;
    
    while( SND_GetNextInstData( bank, &inst, &pos ) ) {
        // Process to perform for the instrument
    }

Revision History