Copyright © 2005-2018 MultiMedia Soft

MIDI.SoundFontUnload method

Previous pageReturn to chapter overviewNext page

Remarks

 

Unloads from memory presets of a sound font previously loaded through the MIDI.SoundFontLoad method.

 

For further details about the use of MIDI protocol see the MIDIMan class section and the How to deal with MIDI protocol tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function SoundFontUnload (

nUniqueId As Int32,

nPreset as Int32,

nBank as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes SoundFontUnload (

Int32 nUniqueId,

Int32 nPreset,

Int32 nBank

);


 

[C++]

public: enumErrorCodes SoundFontUnload (

Int32 nUniqueId,

Int32 nPreset,

Int32 nBank

);


 

 

 

Parameter

Description

 

 

nUniqueId

Number representing the unique identifier of the MIDI SoundFont as returned by a previous call to one between the MIDI.SoundFontInit or MIDI.SoundFontInitFromMemory or MIDI.SoundFontInitFromMemory methods.

nPreset

The preset number to unload. If this parameter is set to -1, all presets are unloaded.

nBank

The bank number of the individual preset to unload.  If this parameter is set to -1, all banks are unloaded.

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.NOERROR (0)

The method call was successful.