This documentation is archived and is not being maintained.
VarBstrFromBool Function
Converts a Boolean value to a BSTR value.
HRESULT VarBstrFromBool(
BOOL boolln,
LCID lcid,
ULONG dwFlags,
BSTR *pbstrOut
);
- boolln
[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 a list of LCIDs, see Supporting Multiple National Languages and Exposing ActiveX Objects.
- 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. See the Remarks section for more information. |
- pbstrOut
[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. |