VarBoolFromStr function

Converts an OLECHAR string to a Boolean value.

Syntax


HRESULT VarBoolFromStr(
  _In_  LPCOLESTR    strIn,
  _In_  LCID         lcid,
  _In_  ULONG        dwFlags,
  _Out_ VARIANT_BOOL *pboolOut
);

strIn [in]

The value to convert.

lcid [in]

The locale identifier.

dwFlags [in]

One or more of the following flags.

Value	Meaning
LOCALE_NOUSEROVERRIDE	Uses the system default locale settings, rather than custom locale settings.
VAR_LOCALBOOL	Uses localized Boolean names.

pboolOut [out]

The resulting value.

This function can return one of these values.

Return code	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 not valid.
E_OUTOFMEMORY	Insufficient memory to complete the operation.