IGeneralCommand.Execute (METH) ¶ METHOD Execute : WORD InOut: Scope Name Type Return Execute WORD Input dwParam1 DWORD dwParam2 DWORD
Recipe_FileParameters (STRUCT) ¶ TYPE Recipe_FileParameters : STRUCT InOut: Name Type pstRecipeDefinition POINTER TO STRING pstRecipe POINTER TO STRING pstFilepath POINTER TO STRING
DateTimeFromWeek (FUN) ¶ FUNCTION DateTimeFromWeek : ULINT Combines the ISO week date parts to a timestamp uiYear := 2009 uiWeek :=1 eWeekday:=WEEKDAY.MONDAY => 29.12.2008 uiYear := 2009 uiWeek :=53 eWeekday:=WEEKDAY.SUNDAY => 03.01.2010 See: https://en.wikipedia.org/wiki/ISO_week_date InOut: Scope Name Type Comment Return DateTimeFromWeek ULINT date and time in milliseconds since 1.1.1970 00:00:00.000 Input uiYear YEAR uiWeek WEEK eWeekday WEEKDAY Output eErrorID ERROR
DayOfWeek (FUN) ¶ FUNCTION DayOfWeek : WEEKDAY Calculates the appropriate value of the WEEKDAY enum that matches the parameter datDate . InOut: Scope Name Type Initial Return DayOfWeek WEEKDAY Input datDate DATE Output eErrorID ERROR ERROR.NO_ERROR
GetDateTime (FUN) ¶ FUNCTION GetDateTime : ULINT Related to UTC this function returns the current date and time in milliseconds since Thursday, 1.1.1970 00:00:00.000, managed in a 64 Bit data type The default IDateTimeProvider implementation ( DateTimeProvider ) is in use InOut: Scope Name Type Comment Return GetDateTime ULINT The current UTC date and time in milliseconds since 1.1.1970 00:00:00.000 Output eErrorID ERROR
GetLocalDateTime (FUN) ¶ FUNCTION GetLocalDateTime : ULINT Related to TimeZone in tzTimeZone this function returns the current date and time in milliseconds since Thursday, 1.1.1970 00:00:00.000, managed in a 64 Bit data type The default IDateTimeProvider implementation ( DateTimeProvider ) is in use InOut: Scope Name Type Comment Return GetLocalDateTime ULINT The current local date and time in milliseconds since 1.1.1970 00:00:00.000 Inout Const tzTimeZone TimeZone Time zone as base for caclulating local time Output eErrorID ERROR
GetTimeStampsDifference (FUN) ¶ FUNCTION GetTimeStampsDifference : ERROR InOut: Scope Name Type Comment Return GetTimeStampsDifference ERROR Input uliDateTimeFirst ULINT First timestamp in milliseconds since 1.1.1970 00:00:00.000 uliDateTimeSecond ULINT Second timestamp in milliseconds since 1.1.1970 00:00:00.000 Output uliDays ULINT Differece of the timestamps in day, hour, minute, second and millisecond uiHours HOUR uiMinutes MINUTE uiSeconds SECOND uiMilliseconds MILLISECOND
IsLeapYear (FUN) ¶ FUNCTION IsLeapYear : BOOL Checks whether the year (uiYear) passed represents a leap year. InOut: Scope Name Type Initial Return IsLeapYear BOOL Input uiYear YEAR Output eErrorID ERROR ERROR.NO_ERROR
JoinDateTime (FUN) ¶ FUNCTION JoinDateTime : ULINT Returns a timestamp in milliseconds since 1.1.1970 00:00:00.000 calculated out of the parameters InOut: Scope Name Type Initial Comment Return JoinDateTime ULINT date and time in milliseconds since 1.1.1970 00:00:00.000 Input uiYear YEAR 1970..2106 uiMonth MONTH uiDay DAY uiHour HOUR uiMinute MINUTE uiSecond SECOND uiMilliseconds MILLISECOND Output eErrorID ERROR ERROR.NO_ERROR
LocalDateTime (FUN) ¶ FUNCTION LocalDateTime : ULINT Based on the inputs uliDateTime and tzTimeZone the corresponding local time is calculated InOut: Scope Name Type Comment Return LocalDateTime ULINT The current period and the local date and time in milliseconds since 1.1.1970 00:00:00.000 Inout Const tzTimeZone TimeZone Time zone as base for caclulating local time Input uliDateTime ULINT UTC timestamp in milliseconds since 1.1.1970 00:00:00.000 See: IDateTimeProvider.GetDateTime or GetDateTime Output eErrorID ERROR ePeriod PERIOD