VarFormatDateTime function (oleauto.h)

Formats a variant containing named date and time information into a string.

Syntax

HRESULT VarFormatDateTime(
  [in]  LPVARIANT pvarIn,
  [in]  int       iNamedFormat,
  [in]  ULONG     dwFlags,
  [out] BSTR      *pbstrOut
);

[in] pvarIn

The variant containing the value to format.

[in] iNamedFormat

The named date formats are as follows.

[in] dwFlags

VAR_CALENDAR_HIJRI is the only flag that can be set.

[out] pbstrOut

Receives the formatted string that represents the variant.

This function can return one of these values.

Return code	Description
S_OK	Success.
E_INVALIDARG	One or more of the arguments is not valid.

This function uses the user's default locale while calling VarTokenizeFormatString and VarFormatFromTokens.