VarBstrFromBool function (oleauto.h)

Converts a Boolean value to a BSTR value.

Syntax

HRESULT VarBstrFromBool(
  [in]  VARIANT_BOOL boolIn,
  [in]  LCID         lcid,
  [in]  ULONG        dwFlags,
  [out] BSTR         *pbstrOut
);

[in] boolIn

The value to convert.

[in] lcid

The locale identifier.

[in] dwFlags

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.

[out] pbstrOut

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.