MIDI.SoundFontInitFromZip method |
|
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 MIDI object section and the How to deal with MIDI protocol tutorial.
Syntax
[Visual Basic] control.MIDI.SoundFontInitFromZip ( strZipPathname as String, strPassword as String, strEntryName as String, bReserved as enumBoolean ) as Long |
[C++] long control.MIDI.SoundFontInitFromZip ( LPCTSTR strZipPathname, LPCTSTR strPassword, LPCTSTR strEntryName, short 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, check the LastError property value in order to get the error code |
Other values |
The method call was successful and the returned value is the unique identifier of the SoundFont. |