VarBstrFromDate

This function converts variant data types to BSTR from DATE.

HRESULT VarBstrFromDate(
[in] DATE dateIn, 
[in] LCID lcid, 
in] ULONG dwFlags,
out] BSTR pbstrOut );

Parameters

  • dateIn
    [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_CALENDAR_HIJRI If set then the Hijri calendar is used. Otherwise the calendar sent in the control panel is used.
    VAR_CALENDAR_THAI If set then the Buddhist year is used.
    VAR_CALENDAR_GREGORIAN If set the Gregorian year is used.
    VAR_FOURDIGITYEARS Forces Automation to use 4-digit years instead of 2-digit years.
    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.

    Flag Description
    LOCALE_NOUSEROVERRIDE Uses the system default locale settings, rather than custom locale settings.
    VAR_CALENDAR_HJRI If set then the Hijri calendar is used. Otherwise the calendar sent in the control panel is used.
    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.
    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.

Return Values

The return value obtained from the returned HRESULT is one of the following.

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.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 2.0 and later Oleauto.h   Oleaut32.lib

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.