Reference

VarFormatPercent(3w)

NAME

VarFormatPercent (OLEAUT32.117)

SYNOPSIS

HRESULT VarFormatPercent
(
LPVARIANT pVarIn,
INT nDigits,
INT nLeading,
INT nParens,
INT nGrouping,
ULONG dwFlags,
BSTR* pbstrOut
)

DESCRIPTION

Format a variant value as a percentage.

PARAMS

pVarIn [In] Variant to format.

nDigits [In] Number of digits following the decimal point (-1 = user default).

nLeading [In] Use a leading zero (-2 = user default, -1 = yes, 0 = no).

nParens [In] Use brackets for values < 0 (-2 = user default, -1 = yes, 0 = no).

nGrouping [In] Use grouping characters (-2 = user default, -1 = yes, 0 = no).

dwFlags [In] Currently unused, set to zero.

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_OVERFLOW, if overflow occurs during the conversion. DISP_E_TYPEMISMATCH, if the variant cannot be formatted.

NOTES

This function uses LOCALE_USER_DEFAULT when determining the number format characters to use.

IMPLEMENTATION

Declared in "oleauto.h".

Implemented in "dlls/oleaut32/varformat.c".

Debug channel "variant".

History