This function converts variant data types to BSTR from BOOL.
HRESULT VarBstrFromBool(BOOL boolIn,LCIDlcid,ULONGdwFlags,BSTR pbstrOut );
Parameters
boolIn
[in] The value to coerce.lcid
[in] For conversions from string and VT_DISPATCH input, the LCID to use for the conversion.dwFlags
[in] Specifies a value made from one or more flags.The following flags can be set for this parameter.
Flag Description LOCALE_NOUSEROVERRIDE Uses the system default locale settings, rather than custom locale settings. VAR_TIMEVALUEONLY Omits the date portion of a VT_DATE and retrieves only the time. Applies to conversions to or from dates.
Not used for VariantChangeType and VariantChangeTypeEx.
VAR_DATEVALUEONLY Omits the time portion of a VT_DATE and retrieves only the date. Applies to conversions to or from dates.
Not used for VariantChangeType and VariantChangeTypeEx.
pbstrOut
[out] Points to the coerced value.
Return Values
Returns the HRESULT values shown in the following table.
| Value | 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 | An argument is invalid. |
| E_OUTOFMEMORY | Memory could not be allocated for the conversion. |
Remarks
Passing invalid (and under some circumstances NULL) pointers to this function causes an unexpected termination of the application.
Requirements
OS Versions: Windows CE 2.0 and later.
Header: Oleauto.h.
Link Library: Oleaut32.lib.
See Also
Automation Functions | BSTR | VariantChangeType | VariantChangeTypeEx
Send Feedback on this topic to the authors