Microsoft XML 2.5 SDK


 

IXTLRuntime::formatDate Method

[This is preliminary documentation and subject to change.]

Formats the supplied date using the specified formatting options.

Visual Basic Syntax

strValue = oXTLRuntime.formatDate(varDate, bstrFormat, varDestLocale)

C/C++ Syntax

HRESULT formatDate(

    VARIANT varDate,

    BSTR bstrFormat,

    VARIANT varDestLocale,

    BSTR *pbstrFormattedString);

Parameters

varDate

[in]
Date that is to be formatted.

bstrFormat

[in]
Formatting specifics. The following codes are supported:

m Months as 1-12
mm Months as 01-12
mmm Months as Jan-Dec
mmmm Months as January-December
mmmmm Months as the first letter of the month
d Days as 1-31
dd Days as 01-31
ddd Days as Sun-Sat
dddd Days as Sunday-Saturday
yy Years as 00-99
yyyy Years as 1900-9999

varDestLocale

[in]
Locale to use in determining the correct sequence to be used in the date. If not supplied, the month-day-year sequence is used.

pbstrFormattedString

[out]
String containing the date in the requested format.

C/C++ Return Value

Returns S_OK if successful, or an error code otherwise.