Formats the supplied time using the specified formatting options.
Visual Basic Syntax
strValue = oXTLRuntime.formatTime(varTime, bstrFormat, varDestLocale)
C/C++ Syntax
HRESULT formatTime(
VARIANT varTime,
BSTR bstrFormat,
VARIANT varDestLocale,
BSTR *pbstrFormattedString);
Parameters
varTime
[in]
Time value that is to be formatted.
bstrFormat
[in]
Formatting to be applied to the time. The following codes are supported:
| h | Hours as 0-23 |
| hh | Hours as 00-23 |
| m | Minutes as 0-59 |
| mm | Minutes as 00-59 |
| s | Seconds as 0-59 |
| ss | Seconds as 00-59 |
| AM/PM | Insert AM or PM, display hours as 12-hour clock |
| am/pm | Insert am or pm, display hours as 12-hour clock |
| A/P | Insert A or P, display hours as 12-hour clock |
| a/p | Insert a or p, display hours as 12-hour clock |
| [h]:mm | Elapsed time in hours; for example, 25.02 |
| [mm]:ss | Elapsed time in minutes; for example, 63:46 |
| [ss] | Elapsed time in seconds |
| ss.00 | Fractions of a second |
varDestLocale
[in]
Locale to use in determining the correct sequence to be used in the time.
pbstrFormattedString
[out]
String containing the time in the requested format.
C/C++ Return Value
Returns S_OK if successful, or an error code otherwise.