Remarks
Loads a specific entry (sound file) from the specified ZIP file. This method acts exactly as the LoadSoundFromZip method but performs a less detailed analysis for files in MP3 format
A successful call to this method will fire the SoundLoaded event.
For further details about using ZIP management refer to the How to manage ZIP files tutorial.
Syntax
[Visual Basic]
control.LoadSoundFastFromZip (
nPlayer as Integer,
strZipPathname as String,
strPassword as String,
strEntryName as String,
bFailOnLowMemory as enumBoolean
) as enumErrorCodes
|
|
[C++]
short control.LoadSoundFastFromZip (
short nPlayer,
LPCTSTR strZipPathname,
LPCTSTR strPassword,
LPCTSTR strEntryName,
short bFailOnLowMemory
);
|
|
Parameter
|
Description
|
|
|
nPlayer
|
Number representing the zero-based index of the player that will load the sound
|
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.
|
bFailOnLowMemory
|
Flag that determines if, for security purposes, loading of the given entry should fail in case there should be no enough memory for storing the unzipped entry.
Supported values are the following:
Mnemonic Value
|
Meaning
|
BOOL_FALSE
|
In case memory shouldn't be enough to contain the unzipped entry, the same would be stored inside a temporary file. The temporary file would be automatically deleted when closing the sound file through the CloseSound method or after loading a new sound file into the given player.
|
BOOL_TRUE
|
In case memory shouldn't be enough to contain the unzipped entry, the method's call would fail.
|
|
Return value
Value
|
Meaning
|
|
|
enumErrorCodes.NOERROR (0)
|
The song file has been loaded successfully.
|
Negative value
|
An error occurred: see the LastError property for further error details or for a list of the possible error values.
|
|
