SND_ReadInstData

Syntax

#include <nitro/snd.h>

BOOL SND_ReadInstData(
        const SNDBankData* bank,
        int prgNo,
        int key,
        SNDInstData* inst );

Arguments

bank	This is the bank data pointer.
prgNo	The program number.
key	The key number.
inst	The pointer to the structure where the instrument data are stored when read.

Return Values

TRUE if the read succeeds. FALSE if it fails.
If TRUE is returned, the correct information has been stored in inst.

Description

Reads the instrument data from the specified bank and loads it into the SNDInstData structure.

The function fails if an invalid program number is specified for prgNo.

If the program number specified for prgNo specifies a drum set or a key split, then the instrument data corresponding to the key number key gets read. If the the program number represents a normal instrument, then key is ignored.

Revision History