VarBoolFromStr

This function converts variant data types to BOOL from OLECHAR.

HRESULT VarBoolFromStr(
  OLECHAR* strIn, 
  LCID lcid, 
  ULONG dwFlags, 
  BOOL* pboolOut 
);

strIn
[in] The value to coerce.
lcid
[in] For conversions from string and VT_DISPATCH input, the LCID to use for the conversion.

dwFlags
[in] A value made from one or more flags. The following table shows the flags that can be set for this parameter.

Flag	Description
LOCALE_NOUSEROVERRIDE	Uses the system default locale settings, rather than custom locale settings.
VAR_TIMEVALUEONLY	Omits the date portion of a VT_DATE and returns only the time. Applies to conversions to or from dates. Not used for VariantChangeType and VariantChangeTypeEx.
VAR_DATEVALUEONLY	Omits the time portion of a VT_DATE and returns only the date. Applies to conversions to or from dates. Not used for VariantChangeType and VariantChangeTypeEx.

The following table shows the HRESULT values that can be returned by this function.

Value	Description
S_OK	Success.
DISP_E_BADVARTYPE	The input parameter is not a valid type of variant.
DISP_E_OVERFLOW	The data pointed to by the output parameter does not fit in the destination type.
DISP_E_TYPEMISMATCH	The argument could not be coerced to the specified type.
E_INVALIDARG	One of the arguments is invalid.
E_OUTOFMEMORY	Memory could not be allocated for the conversion.

Passing invalid (and under some circumstances NULL) pointers to this function causes an unexpected termination of the application.

OS Versions: Windows CE 2.0 and later.
Header: Oleauto.h.
Link Library: Oleaut32.lib.

Additional resources