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

.SH NAME
\fBVarFormat\fR (OLEAUT32.87)
.SH SYNOPSIS
HRESULT VarFormat
 (
  LPVARIANT \fIpVarIn\fR,
  LPOLESTR  \fIlpszFormat\fR,
  int       \fInFirstDay\fR,
  int       \fInFirstWeek\fR,
  ULONG     \fIdwFlags\fR,
  BSTR*     \fIpbstrOut\fR
 )

.SH DESCRIPTION
.PP
Format a variant from a format string. 

.SH PARAMS
\fIpVarIn\fR \fB[In]\fR  Variant to format.
.PP
\fIlpszFormat\fR \fB[In]\fR  Format string (see notes).
.PP
\fInFirstDay\fR \fB[In]\fR  First day of the week, (See \fBVarTokenizeFormatString(3w)\fR for details).
.PP
\fInFirstWeek\fR \fB[In]\fR  First week of the year (See \fBVarTokenizeFormatString(3w)\fR for details).
.PP
\fIdwFlags\fR \fB[In]\fR  Flags for the format (\fBVAR_\fR flags from \fB"oleauto.h"\fR).
.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
\fB-\fR See Variant-Formats for details concerning creating format strings. 
.PP
\fB-\fR This function uses \fBLOCALE_USER_DEFAULT\fR when calling \fBVarTokenizeFormatString(3w)\fR and \fBVarFormatFromTokens(3w)\fR. 

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