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

.SH NAME
\fBVarBoolFromStr\fR (OLEAUT32.125)
.SH SYNOPSIS
HRESULT VarBoolFromStr
 (
  OLECHAR*      \fIstrIn\fR,
  LCID          \fIlcid\fR,
  ULONG         \fIdwFlags\fR,
  VARIANT_BOOL* \fIpBoolOut\fR
 )

.SH DESCRIPTION
.PP
Convert a \fBVT_BSTR\fR to a \fBVT_BOOL\fR. 

.SH PARAMS
\fIstrIn\fR \fB[In]\fR  Source.
.PP
\fIlcid\fR \fB[In]\fR  \fBLCID\fR for the conversion.
.PP
\fIdwFlags\fR \fB[In]\fR  Flags controlling the conversion (\fBVAR_\fR flags from \fB"oleauto.h"\fR).
.PP
\fIpBoolOut\fR \fB[Out]\fR  Destination.
.PP

.SH RETURNS
.PP
\fBSuccess:\fR \fBS_OK\fR. 
.PP
\fBFailure:\fR \fBE_INVALIDARG\fR, if \fIpBoolOut\fR is invalid. \fBDISP_E_TYPEMISMATCH\fR, if the type cannot be converted. 

.SH NOTES
.PP
\fB-\fR \fIstrIn\fR will be recognised if it contains \fB"#TRUE#"\fR or \fB"#FALSE#"\fR. Additionally, it may contain (in any case mapping) the text \fB"TRUE"\fR or \fB"FALSE"\fR. 
.PP
\fB-\fR If \fIdwFlags\fR includes \fBVAR_LOCALBOOL\fR, then the text may also match the localised text of \fB"TRUE"\fR or \fB"FALSE"\fR in the language specified by \fIlcid\fR. 
.PP
\fB-\fR If none of these matches occur, the string is treated as a numeric string and the boolean \fIpBoolOut\fR will be set according to whether the number is zero or not. The \fIdwFlags\fR parameter is passed to \fBVarR8FromStr(3w)\fR for this conversion. 
.PP
\fB-\fR If the text is not numeric and does not match any of the above, then \fBDISP_E_TYPEMISMATCH\fR is returned. 

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