peoplecodeapi

ConvertTimeToBase

Mon 01 January 2018

Syntax 

ConvertTimeToBase(texttime,{timezone | "Local" | "Base"})

Description

Use the ConvertTimeToBase function to convert the text value texttime to a Time value and converts it to the base time. This function automatically calculates whether daylight saving time is in effect for the given texttime .

This function is useful for users to convert constant times in specific time zones into database time. For example, there is a deadline for completing Federal Funds transfers by 3:00 PM Eastern Time. ConvertTimeToBase does this conversion, taking into account daylight saving time. The date used to calculate whether daylight saving time is in effect is the current date.

The system’s base time zone is specified on the PSOPTIONS table.

Parameters

Field or Control

Definition

texttime

Specify a time value represented as text (e.g., "3:00 PM")

timezone | Local | Base

Specify a value for converting texttime . Values are:

  • timezone - a time zone abbreviation or a field reference to be used for converting texttime

  • Local - use the local time zone for converting texttime.

  • Base - use the base time zone for converting texttime .

Returns

Returns a time value in the base time zone.