Remarks
Given an amount of time, expressed in milliseconds, retrieves a string containing the formatted time 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 the milliseconds.
For example "04:34:200" indicates a time of 0 hours, 4 minutes, 34 seconds and 200 milliseconds.
Syntax
[Visual Basic]
control.FromMsToFormattedTime (
nTimeInMs as Double,
bShowHour as enumBoolean,
bShowMs as enumBoolean,
strHourSeparator as String,
strMsSeparator as String,
nNumberOfMsDigits as Integer
) as String
|
|
[C++]
LPCTSTR control.FromMsToFormattedTime (
double nTimeinMs,
short bShowHour,
short bShowMs,
BSTR strHourSeparator,
BSTR strMsSeparator,
short nNumberOfMsDigits
);
|
|
Parameter
|
Description
|
|
|
nfTimeInMs
|
Time, expressed in milliseconds, to convert to a formatted string
|
bShowHour
|
Boolean value that specifies the player to avoid displaying the 'hour' position field.
Supported values are the following:
Mnemonic constant
|
Value
|
Meaning
|
BOOL_FALSE
|
0
|
Doesn't show hour value
|
BOOL_TRUE
|
1
|
Shows hour value
|
|
bShowMs
|
Boolean value that specifies the player to avoid displaying the 'milliseconds' position field.
Supported values are the following:
Mnemonic constant
|
Value
|
Meaning
|
BOOL_FALSE
|
0
|
Doesn't show milliseconds value
|
BOOL_TRUE
|
1
|
Shows milliseconds value
|
|
strHourSeparator
|
Character used to separate hours, minutes and seconds, typically this should be set to ":"
|
strMsSeparator
|
Character used to separate seconds and milliseconds, typically this should be set to "."
|
nNumberOfMsDigits
|
Number of characters used to represent milliseconds digits, can be in the range from 1 to 3; values outside this range will be automatically set to 3.
|
Return value
Value
|
Meaning
|
|
|
Empty string
|
An error occurred (see the LastError property for further error details)
|
Valid string
|
The formatted time
|
|
