Methods > Init and info > GetFormattedSoundDuration method

Remarks

Retrieves a string containing the formatted duration of the sound under editing using the following format [hh:mm:ss:ms(3)] in which hh is for hours, mm is for minutes, ss is for seconds and ms(3) are three characters representing milliseconds. For example [04:34:200] indicates a song during 0 hours (the hours number is automatically omitted if 0), 4 minutes, 34 seconds and 200 milliseconds.

The song duration in milliseconds can be obtained using the GetSoundDuration method.

Syntax

[Visual Basic]

control.GetFormattedSoundDuration (

bShowHour as enumBoolean,

bShowMs as enumBoolean

) as String

[C++]

LPCTSTR control.GetFormattedSoundDuration (

short bShowHour,

short bShowMs

);

Parameter

Description

bShowHour

Boolean value that specifies to avoid displaying the 'hour' position field

Mnemonic constant	Value	Meaning
BOOL_FALSE	0	Doesn't show hour value
BOOL_TRUE	1	Shows hour value

bShowMs

Boolean value that specifies to avoid displaying the 'milliseconds' position field

Mnemonic constant	Value	Meaning
BOOL_FALSE	0	Doesn't show milliseconds value
BOOL_TRUE	1	Shows milliseconds value

Return value

Value	Meaning

Empty string	An error occurred (see the LastError property for further error details)
Valid string	The formatted sound duration