Cicode Programming Reference > Cicode Function Categories > Timestamp Functions > StrToTimestamp

StrToTimestamp

This function converts timestamp in a STRING format into a TIMESTAMP format. This function can be used in browsing functions to convert timestamp fields returned as a string.

Syntax

TIMESTAMP StrToTimestamp(STRING String [, INT Format [, INT UTC]])

String:

The date and time as a STRING or TIMESTAMP

Format:

The format of the string. Should be 15. Other types reserved for future use.

UTC:

If 1, the date is considered to be in UTC. Otherwise, local time is used. This field is only applicable for format STRING formats (i.e. format is not equal 15).

Return Value

This function returns a date in TIMESTAMP format if successful, otherwise returns TIMESTAMP of January 1, 1601, 00:00:00 (UTC). If the function is unsuccessful you can call the IsError() function to get the actual error code.

Related Functions

SchdSpecialItemAdd, SchdSpecialItemDelete, SchdSpecialItemGetField, SchdConfigGetField, SchdGetField, SchdOpen, SchdSpecialItemAdd, ScheduleItemAdd, ScheduleItemModify, ScheduleItemSetRepeat

See Also

Scheduler Functions

Timestamp Functions

Published June 2018