Copyright © 2005-2018 MultiMedia Soft

MIDI.SoundFontInitFromZip method

Previous pageReturn to chapter overviewNext page

Remarks

 

Initializes a MIDI SoundFont stored inside a ZIP file. After initialization the SoundFont stays in memory until the MIDI.SoundFontFree method is called.

 

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 SoundFontInitFromZip (

strZipPathname as String,

strPassword as String,

strEntryName as String,

bReserved as Boolean

) as Int32


 

[C#]

public Int32 SoundFontInitFromZip (

string strZipPathname,

string strPassword,

string strEntryName,

bool bReserved

);


 

[C++]

public: Int32 SoundFontInitFromZip (

string strZipPathname,

string strPassword,

string strEntryName,

bool bReserved

);


 

Parameter

Description

 

 

strZipPathname

String containing the absolute pathname of the ZIP file to load.

strPassword

String containing the optional password for accessing the requested entry; leave it empty if not needed.

strEntryName

String representing the name of the entry to extract and load.

bReserved

Reserved for future uses

 

 

Return value

 

Value

Meaning

 

 

Value = 0

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

Other values

The method call was successful and the returned value is the unique identifier of the SoundFont.