Important: |
---|
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
This function converts variant data types to BSTRfrom unsigned short.
Syntax
WINOLEAUTAPI VarBstrFromUI2( USHORT uiIn, LCID lcid, ULONG dwFlags, BSTR pbstrOut ); |
Parameters
- uiIn
-
[in] The value to coerce.
- lcid
-
[in] For conversions from string and VT_DISPATCH input, the LCID to use for the conversion.
- 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_TIMEVALUEONLY
Omits the date portion of a VT_DATE and returns only the time.
Applies to conversions to or from dates.
Not used for VariantChangeTypeand VariantChangeTypeEx.
VAR_DATEVALUEONLY
Omits the time portion of a VT_DATE and returns only the date.
Applies to conversions to or from dates.
Not used for VariantChangeTypeand VariantChangeTypeEx.
- pbstrOut
-
[out] Points to the coerced value.
Return Value
The following HRESULT values can be returned.
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 into this function causes an unexpected termination of the application.
To determine whether the platform supports this function, see Determining Supported COM APIs.
Requirements
Header | oleauto.h |
Library | oleaut32.lib |
Windows Embedded CE | Windows CE 2.0 and later |
Windows Mobile | Windows Mobile Version 5.0 and later |
See Also
Reference
Automation FunctionsBSTR
VariantChangeType
VariantChangeTypeEx