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 (the hours number is automatically omitted if 0), 4 minutes, 34 seconds and 200 milliseconds.
Syntax
[Visual Basic]
control.GetFormattedTime (
nPlayer as Integer,
nTimeInMs as Long,
bShowHour as enumBoolean,
bShowMs as enumBoolean
) as String
|
|
[C++]
LPCTSTR control.GetFormattedTime (
short nPlayer,
long nTimeinMs,
short bShowHour,
short bShowMs
);
|
|
Parameter
|
Description
|
|
|
nPlayer
|
Number representing the zero-based index of the involved player
|
nTimeinMs
|
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
|
|
Return value
Value
|
Meaning
|
|
|
Empty string
|
An error occurred (see the LastError property for further error details)
|
Valid string
|
The formatted time
|
|
