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

.SH NAME
\fBVarTokenizeFormatString\fR (OLEAUT32.140)
.SH SYNOPSIS
HRESULT VarTokenizeFormatString
 (
  LPOLESTR \fIlpszFormat\fR,
  LPBYTE   \fIrgbTok\fR,
  int      \fIcbTok\fR,
  int      \fInFirstDay\fR,
  int      \fInFirstWeek\fR,
  LCID     \fIlcid\fR,
  int*     \fIpcbActual\fR
 )

.SH DESCRIPTION
.PP
Convert a format string into tokenised form. 

.SH PARAMS
\fIlpszFormat\fR \fB[In]\fR  Format string to tokenise.
.PP
\fIrgbTok\fR \fB[Out]\fR  Destination for tokenised format.
.PP
\fIcbTok\fR \fB[In]\fR  Size of \fIrgbTok\fR in bytes.
.PP
\fInFirstDay\fR \fB[In]\fR  First day of the week (\fB1-7\fR, or \fB0\fR for current system default).
.PP
\fInFirstWeek\fR \fB[In]\fR  How to treat the first week (see notes).
.PP
\fIlcid\fR \fB[In]\fR  Locale Id of the format string.
.PP
\fIpcbActual\fR \fB[Out]\fR  If non-NULL, filled with the first token generated.
.PP

.SH RETURNS
.PP
\fBSuccess:\fR \fBS_OK\fR. \fIrgbTok\fR contains the tokenised format. 
.PP
\fBFailure:\fR \fBE_INVALIDARG\fR, if any argument is invalid. \fBTYPE_E_BUFFERTOOSMALL\fR, if \fIrgbTok\fR is not large enough. 

.SH NOTES
.PP
Valid values for the \fInFirstWeek\fR parameter are: 
.br
 Value  Meaning
.br
 -----  -------
.br
   0    Use the current system default
.br
   1    The first week is that containing Jan 1
.br
   2    Four or more days of the first week are in the current year
.br
   3    The first week is 7 days long
.PP
See \fBVariant-Formats(3w)\fR, \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.