Copyright © 2006-2016 MultiMedia Soft

FromMsToFormattedTime method

Previous pageReturn to chapter overviewNext page

Remarks

 

Given an amount of time, expressed in milliseconds, retrieves a string containing the formatted time using the following format [hh:mm:ss:ms] in which hh is for hours, mm is for minutes, ss is for seconds and ms are 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]

Public Function FromMsToFormattedTime (

fTimeInMs as double,

bShowHour as Boolean,

bShowMs as Boolean,

strHourSeparator as String,

strMsSeparator as String,

nNumberOfMsDigits as Int32

) as String


 

[C#]

public string FromMsToFormattedTime (

double fTimeInMs,

bool bShowHour,

bool bShowMs,

string strHourSeparator,

string strMsSeparator,

Int32 nNumberOfMsDigits

);


 

[C++]

public: string FromMsToFormattedTime (

double fTimeInMs,

bool bShowHour,

bool bShowMs,

string strHourSeparator,

string strMsSeparator,

Int32 nNumberOfMsDigits

);


 

 

Parameter

Description

 

 

fTimeInMs

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:

Value

Meaning

false

Doesn't show hour value

true

Shows hour value

bShowMs

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

Supported values are the following:

Value

Meaning

false

Doesn't show milliseconds value

true

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