Share via

2.5.4.119 Year

  • Article

The Year function returns the year, according to the Gregorian calendar, from a value representing a date and time.

ABNF:

 Year = val [val] sp ("1" / "2") ";YEAR():129"

Required Arguments:

Name: DateTimeArg

Type: vAny

An argument that specifies a date and time value.

Optional Arguments:

Name: Locale

Type: vLanguageID

An argument that specifies an LCID to use when parsing DateTimeArg.

Return Value:

Type: PtgUnsWord, PtgErr

This function attempts a conversion, as described by the DateTime function, of DateTimeArg to a PtgDate. If the conversion succeeds, the function returns a PtgUnsWord containing the year component from DateTimeArg. The value is greater than or equal to 1 and less than or equal to 9999. If the conversion fails, the function returns a PtgErr with an error code of #VALUE!.