formatTime Method (Compact 2013)

3/26/2014

Formats the time using the specified formatting options.

Syntax

strValue = oXTLRuntime.formatTime(varTime, bstrFormat, varDestLocale);

HRESULT formatTime(
  VARIANT varTime,
  BSTR bstrFormat,
  VARIANT varDestLocale,
  BSTR* pbstrFormattedString
};

Parameters

Script

• varTime
  Variant. Time value that is to be formatted.

• bstrFormat
  String. Specified formatting to be applied to the time. See Remarks.

• varDestLocale
  [optional] Variant. Locale to use in determining the correct sequence to be employed in the time.

C/C++

• varTime
  [in] Time value that is to be formatted.

• bstrFormat
  [in] Formatting to be applied to the time. See Remarks.

• varDestLocale
  [in, optional] Variant. Locale to use in determining the correct sequence to be employed in the time.

• pbstrFormattedString
  [out, retval] String containing the time in the requested format.

Return Value

Script

String. Returns the string containing the time in the requested format.

C/C++

• S_OK
  Value returned if successful.

Remarks

The following table shows the codes that are supported for time formats.

Time format	Meaning
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	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

This method applies to the following interface:

IXTLRuntime.

Requirements

Header	msxml2.h, msxml2.idl
Library	uuid.lib

See Also

Reference

XSLT Methods