Classes > RecordedSound class > Methods > RecordedSound.AddToZip method

Remarks

Adds the recorded sound to a ZIP file session previously opened through the ZIP.Open method or created through the ZIP.Create method.

This method only updates the ZIP session: to update or rewrite the ZIP file the ZIP.Save method would need to be called.

For further details about recorded sound methods refer to the RecordedSound class section.

For further details see the How to export a recorded sound section.

For further details about methods for ZIP management refer to the ZipMan class.

For details about using ZIP management refer to the How to manage ZIP files tutorial.

Syntax

[Visual Basic]

Public Function AddToZip (

strEntryName as String,

bAddExtraPath as Boolean

) as enumErrorCodes

[C#]

public enumErrorCodes AddToZip (

string strEntryName,

bool bAddExtraPath

);

[C++]

public: enumErrorCodes AddToZip (

string strEntryName,

bool bAddExtraPath

);

Parameter

Description

strEntryName

String representing the name of the entry to add.

If sound data resulting from a recording session has been stored on a file, you may use the full pathname of the destination file.

In case the ZIP session should already contain an entry with the same name, this would be removed and replaced by the new one: you may use the ZIP.EntryUncompressedSizeGet method in order to understand if an entry with a specific name already exists.

bAddExtraPath

This parameter is ignored if sound data resulting from a recording session has been stored on a memory buffer

If sound data resulting from a recording session has been stored on a file, this value represents a boolean flag determining if the relative path of the recorded sound file should be added to the destination path inside the ZIP file session.

Supported values are the following:

Value

Meaning

false

The relative path of the recorded sound file is not added.

If for example the strEntryName parameter should be "c:\first_dir\second_dir\myFile.mp3" the final name of the entry would be "myFile.mp3"

true

The relative path of the recorded sound file is added.

If for example the strEntryName parameter should be "c:\first_dir\second_dir\myFile.mp3" the final name of the entry would be "first_dir/second_dir/myFile.mp3"

Return value

Value	Meaning

Negative value	An error occurred. Check the LastError property value in order to see the last error.
enumErrorCodes.ERR_NOERROR (0)	The method call was successful.