VarBstrFromI1

This function converts variant data types to BSTR from char.

WINOLEAUTAPI VarBstrFromI1(
  char cIn, 
  LCID lcid, 
  ULONG dwFlags, 
  BSTR pbstrOut 
);

Parameters

  • cIn
    [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 VariantChangeType and 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 VariantChangeType and VariantChangeTypeEx.
  • pbstrOut
    [out] Points to the coerced value.

Return Values

The following table shows the HRESULT values that can be returned by this function.

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 One of the arguments is invalid.
E_OUTOFMEMORY Memory could not be allocated for the conversion.

Remarks

Passing into this function any invalid and, under some circumstances, NULL pointers will result in unexpected termination of the application.

To determine whether the platform supports this function, see Determining Supported COM APIs.

Requirements

OS Versions: Windows CE 2.0 and later.
Header: Oleauto.h.
Link Library: Oleaut32.lib.

See Also

BSTR | VariantChangeType | VariantChangeTypeEx | Determining Supported COM APIs

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.