RelativeTime

Description

Obtains a time that occurs a specified number of seconds after or before another time within a 24-hour period.

Syntax

RelativeTime ( time, n )

Argument

Description

time

A value of type time

n

A long number of seconds


Return value

Time. Returns the time that occurs n seconds after time if n is greater than 0. Returns the time that occurs n seconds before time if n is less than 0. The maximum return value is 23:59:59. If any argument's value is null, RelativeTime returns null.

Usage

All PowerBuilder functions except RelativeTime use the Windows API to process dates and times, so in most instances processing of Daylight Savings Time (DST) is dependent on the operating system. However, the RelativeTime function is not DST-aware and therefore may return an incorrect time in a region that is using DST.

Examples

This statement returns 19:01:41:

RelativeTime(19:01:31, 10)

This statement returns 19:01:21:

RelativeTime(19:01:31,  - 10)

See also

SecondsAfter

RelativeTime method for DataWindows in the section called “RelativeTime” in DataWindow Reference.