Developing Apama Applications > Developing Apama Applications in EPL > Using Correlator Plug-ins in EPL > Using the Time Format plug-in > Time Format plug-in format functions
Time Format plug-in format functions
The format functions convert the time parameter to the local time and return that time in the format you specify.
Usage
string format(float time, string format)
 
string formatUTC(float time, string format)
 
string formatWithTimeZone(float time, string format, string tzName)
Usage description
time
Float that indicates the time you want to format. This value is the number of seconds since the epoch in UTC. This is the same format used by the currentTime variable. For information about the currentTime variable, see Getting the current time.
format
String that specifies the format that you want the returned time to have. For details about what you can specify for the format string, see Format specification for the Time Format plug-in functions.
name
String that specifies the name of a time zone.
The format() function converts the time parameter to the local time and returns that time in the format you specify.
The formatUTC() function returns the time specified in the time parameter in the format you specify. The formatUTC() function always returns UTC (GMT no matter what the local time is). This is true of all *UTC functions.
The formatWithTimeZone() function converts the time parameter, which is UTC, to the time in the time zone you specify and returns that time in the format you specify.
Copyright © 2013 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or Terracotta Inc., San Francisco, CA, USA, and/or Software AG (Canada) Inc., Cambridge, Ontario, Canada, and/or, Software AG (UK) Ltd., Derby, United Kingdom, and/or Software A.G. (Israel) Ltd., Or-Yehuda, Israel and/or their licensors.