VarUdateFromDate function

Converts a time and date converted from variant format to MS-DOS format.

Syntax

HRESULT VarUdateFromDate(
  _In_  DATE  dateIn,
  _In_  ULONG dwFlags,
  _Out_ UDATE *pudateOut
);

Parameters

dateIn [in]

The packed date.

dwFlags [in]

Set for alternative calendars such as Hijri, Polish and Russian.

pudateOut [out]

The unpacked date.

Return value

This function can return one of these values.

Remarks

The UDATE structure is used with VarDateFromUdate and VarUdateFromDate. It represents an "unpacked" date.

typedef struct {
    SYSTEMTIME st;
    USHORT  wDayOfYear;
} UDATE;

The VarUdateFromDate function will accept invalid dates and try to fix them when resolving to a VARIANT time. For example, an invalid date such as 2/29/2001 will resolve to 3/1/2001. Only days are fixed, so invalid month values result in an error being returned. Days are checked to be between 1 and 31. Negative days and days greater than 31 results in an error. A day less than 31 but greater than the maximum day in that month has the day promoted to the appropriate day of the next month. A day equal to zero resolves as the last day of the previous month. For example, an invalid dates such as 2/0/2001 will resolve to 1/31/2001.

Requirements