VarBstrFromBool(3w)

Usage

HRESULT VarBstrFromBool
(
VARIANT_BOOL boolIn,
LCID lcid,
ULONG dwFlags,
BSTR* pbstrOut
)

Overview

Convert a VT_BOOL to a VT_BSTR.

Params

boolIn [In] Source.

lcid [In] LCID for the conversion.

dwFlags [In] Flags controlling the conversion (VAR_ flags from "oleauto.h").

pbstrOut [Out] Destination.

Returns

Success: S_OK.

Failure: E_INVALIDARG, if pbstrOut is invalid. E_OUTOFMEMORY, if memory allocation fails.

Notes

If dwFlags includes VARIANT_LOCALBOOL, this function converts to the localised text of "TRUE" or "FALSE". To convert a boolean into a numeric string of "0" or "-1", use VariantChangeTypeTypeEx(3w).

Implementation

Declared in "oleauto.h".

Implemented in "dlls/oleaut32/vartype.c".

Debug channel "variant".

Releases

4 releases since Debian 4.0 (Etch); the text changed 3 times.