Windows Dev Center

VarBoolFromStr Function

Converts an OLECHAR string to a Boolean value.

HRESULT VarBoolFromStr(
  OLECHAR  *strln,
  LCID  lcid,
  unsigned long  dwFlags,
  VARIANT_BOOL   *pboolOut
);

strln

[in] The value to coerce.

lcid

[in] For conversions from string and VT_DISPATCH input, the LCID to use for the conversion. This parameter allows locale-specific parsing to occur. For more information, see Supporting Multiple National Languages and Exposing ActiveX Objects. For a list of LCIDs, see Locale ID (LCID) Chart.

dwFlags

[in] One or more of the following flags:

Flag

Description

LOCALE_NOUSEROVERRIDE

Uses the system default locale settings, rather than custom locale settings.

VAR_LOCALBOOL

Uses localized Boolean names.

pboolOut

[out] Points to the coerced value.

The return value obtained from the returned HRESULT is one of the following.

Value

Meaning

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.

Show:
© 2015 Microsoft