VarUI4FromStr

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function converts variant data types to unsigned long from BSTR.

Syntax

WINOLEAUTAPI VarUI4FromStr(
  BSTR strIn, 
  LCID lcid, 
  ULONG dwFlags, 
  ULONG* pulOut 
);

Parameters

• strIn
  [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.

• pulOut
  [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 Functions
BSTR
VariantChangeType
VariantChangeTypeEx

Concepts

Determining Supported COM APIs