Share via

2.5.4.44 Hour

  • Article

The Hour function returns the hour from a value representing a date and time.

ABNF:

 Hour = val [val] sp ("1" / "2") ";HOUR():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 hour component from DateTimeArg. The value is greater than or equal to zero and less than or equal to 23. If the conversion fails, the function returns a PtgErr with an error code of #VALUE!.