Copyright © 2008-2018 MultiMedia Soft

ConvertFileDestOptionsSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets options to be applied during a sound format conversion session started through calls to the ConvertFile, ConvertFileRange, ConvertFileRaw, ConvertFileRawRange and ConvertAutomationExecute methods.

 

For further information about sound files conversion see the How to convert format of sound files tutorial.

 

 

Syntax

 

[Visual Basic]

control.ConvertFileDestOptionsSet (

strFilenamePrefix as string,

strCustomExtension as string,

strDestFolder as string,

bKeepTagInfo as enumBoolean

) as enumErrorCodes


 

[C++]

short control.ConvertFileDestOptionsSet (

LPCTSTR strFilenamePrefix,

LPCTSTR strCustomExtension,

LPCTSTR strDestFolder,

short bKeepTagInfo

);


 

 

Parameter

Description

 

 

strFilenamePrefix

String representing the filename prefix of the destination file; leave it empty for keeping the same filename of the source file.

strCustomExtension

String representing the extension of the destination file; leave it empty for keeping the default extension of the chosen output format.

strDestFolder

String representing the destination folder; leave it empty for storing the destination file inside the same folder of the source file.

bKeepTagInfo

Boolean value that tells if eventual existing tag info stored inside the source file must be kept during conversion and stored inside the destination file.

Supported values are the following:

Mnemonic Value

Meaning

BOOL_FALSE

Ignore eventual tag info available inside the source file.

BOOL_TRUE

Keep eventual tag info available inside the source file.

If source files should be in MP3 format, which may contain a combination of tags in different formats like ID3V2, ID3V1 and LYRICS3, when converting to another format the search order for tag information would be ID3V2 first, then LYRICS3 and finally ID3V1.

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred, check the LastError property value in order to see the error code meaning

enumErrorCodes.ERR_NOERROR (0)

The method call was successful.