NAME¶

VarFormat (OLEAUT32.87)

SYNOPSIS¶

HRESULT VarFormat
(
LPVARIANT pVarIn,
LPOLESTR lpszFormat,
int nFirstDay,
int nFirstWeek,
ULONG dwFlags,
BSTR* pbstrOut
)

DESCRIPTION¶

Format a variant from a format string.

PARAMS¶

pVarIn [In] Variant to format. lpszFormat [In] Format string (see notes). nFirstDay [In] First day of the week, (See VarTokenizeFormatString(3w) for details). nFirstWeek [In] First week of the year (See VarTokenizeFormatString(3w) for details). dwFlags [In] Flags for the format (VAR_ flags from "oleauto.h"). pbstrOut [Out] Destination for formatted string.

RETURNS¶

Success: S_OK. pbstrOut contains the formatted value. Failure: E_INVALIDARG, if any parameter is invalid. E_OUTOFMEMORY, if enough memory cannot be allocated. DISP_E_TYPEMISMATCH, if the variant cannot be formatted.

NOTES¶

- See Variant-Formats for details concerning creating format strings. - This function uses LOCALE_USER_DEFAULT when calling VarTokenizeFormatString(3w) and VarFormatFromTokens(3w).

IMPLEMENTATION¶

Declared in "oleauto.h". Implemented in "dlls/oleaut32/varformat.c". Debug channel "variant".