.\" -*- nroff -*-
.\" Generated file - DO NOT EDIT!
.TH VarFormatCurrency 3w "Oct 2012" "Wine API" "Wine API"

.SH NAME
\fBVarFormatCurrency\fR (OLEAUT32.127)
.SH SYNOPSIS
HRESULT VarFormatCurrency
 (
  LPVARIANT \fIpVarIn\fR,
  INT       \fInDigits\fR,
  INT       \fInLeading\fR,
  INT       \fInParens\fR,
  INT       \fInGrouping\fR,
  ULONG     \fIdwFlags\fR,
  BSTR*     \fIpbstrOut\fR
 )

.SH DESCRIPTION
.PP
Format a variant value as a currency. 

.SH PARAMS
\fIpVarIn\fR \fB[In]\fR  Variant to format.
.PP
\fInDigits\fR \fB[In]\fR  Number of digits following the decimal point (\fB-1\fR = user default).
.PP
\fInLeading\fR \fB[In]\fR  Use a leading zero (\fB-2\fR = user default, \fB-1\fR = yes, \fB0\fR = no).
.PP
\fInParens\fR \fB[In]\fR  Use brackets for values < \fB0\fR (\fB-2\fR = user default, \fB-1\fR = yes, \fB0\fR = no).
.PP
\fInGrouping\fR \fB[In]\fR  Use grouping characters (\fB-2\fR = user default, \fB-1\fR = yes, \fB0\fR = no).
.PP
\fIdwFlags\fR \fB[In]\fR  Currently unused, set to zero.
.PP
\fIpbstrOut\fR \fB[Out]\fR  Destination for formatted string.
.PP

.SH RETURNS
.PP
\fBSuccess:\fR \fBS_OK\fR. \fIpbstrOut\fR contains the formatted value. 
.PP
\fBFailure:\fR \fBE_INVALIDARG\fR, if any parameter is invalid. \fBE_OUTOFMEMORY\fR, if enough memory cannot be allocated. \fBDISP_E_TYPEMISMATCH\fR, if the variant cannot be formatted. 

.SH NOTES
.PP
This function uses \fBLOCALE_USER_DEFAULT\fR when determining the currency format characters to use. 

.SH IMPLEMENTATION
.PP
Declared in \fB"oleauto.h"\fR. 
.PP
Implemented in \fB"dlls/oleaut32/varformat.c"\fR. 
.PP
Debug channel \fB"variant"\fR.