02
Sat, Nov
2 New Articles

Supplementing RPG's Native Date/Time Support

RPG
Typography
  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times

I often recommend using the C language runtime library functions in RPG IV as a supplement to the built-in functions and opcodes that are already part of the RPG IV language. This week, I want to introduce you to the C language's date and time functions. But first, let me review how you interface with the C language from RPG IV.

QC2LE Binding Directory

A special binding directory on every iSeries/i5 system contains the C language runtime library service programs. Most of you have probably seen or heard of it before, and many have perhaps used it. That binding directory is QC2LE, and it contains a list of service programs needed to allow the C language procedures to be called from RPG IV. The BNDDIR(QC2LE) keyword on the CRTBNDRPG and CRTPGM commands is all you need to use to include C runtime procedures in your RPG IV program. QC2LE is not an RPG IV-specific binding directory, however, and may be used by all ILE-targeted languages: CL, COBOL, C, or C++. But the C language implicitly uses QC2LE, so no BNDDIR parameter is required.

The C language has several interesting ways of evoking a procedure call. Fortunately, one of those methods allows the procedure to be called via a pointer to a procedure. IBM has exposed those functions in service programs. This is where the QC2LE binding directory comes in.

Since the C runtime library functions are exported from service programs, binding to them is as easy as writing an RPG IV procedure prototype. In fact, it is so easy to interface RPG IV with C that I would suggest that the RPG IV language supports every procedure the C language has, but since RPG IV has its own set of instructions, it is a better language than C. Take that, you C bigots!

In previous articles, I've illustrated how to convert character values to numeric using C runtime library functions atoll() and atoi(). This allows you to convert a number that is in text format (stored in a character field) into a true numeric value and then store that value in a numeric field. In other words, you can call a routine to do what the MOVE opcode already does. The benefit is that you can call atoll() from within an expression. Oh yes, and MOVE is not supported in the /free specification, so you'd have to switch to atoll() or atoi() to accomplish same thing.

Here's the prototype for the atoll() function:

     D atoll           PR            20I 0 ExtProc('atoll')
     D  szCharIn                       *   Value Options(*STRING)

Use the atoll() function as follows:

.....DName+++++++++++EUDS.......Length+TDc.Functions++++++++++++
     D szCust          S             10A   Inz('1234')
     D nCustNo         S              7P 0

     C                   eval      nCustNo = atoll(szCust)

This technique can be used on every release since V3R7, so there's no confusion about which releases support this capability (as there is with %INT and %DEC).

The QC2LE binding directory should be inserted into all source members that call any C language routine. I make it a habit to include it on my source member's Header specifications, for example:

     H  BNDDIR('QC2LE' : 'XTOOLS')

Remember that object names, such as the binding directory names above, must be in all uppercase letters; otherwise, the compiler will not find them.

Additional Date/Time Functions from C

RPG IV's support for date and time data types is pretty good. But while the traditional operation codes are stable and well known (ADDDUR, SUBDUR, EXTRCT, and TIME) they do not offer more than basic functionality.

There are C language runtime functions that do more than the traditional RPG IV operation codes. Some of the C functions that are useful include asctime, ctime, time, localtime, mktime, and strftime. While there are other date/time functions in the C compiler, the most commonly used date/time functions are summarized in the following table:

C Runtime Library TIME Functions
Function
Description
asctime
Returns character string version of date/time
ctime
Returns character string version of date/time with current time as the default.
time
Gets current time into a TIME_T value
localtime
Returns a TM structure from a TIME_T value
mktime
Returns a TIME_T value from a TM structure
difftime
Calculate the difference between two TIME_T values.

ASCTIME--Get Date/Time as Text

The asctime() procedure returns the character string form of the date and time value stored in a TM data structure. Here's the prototype:

.....DName+++++++++++EUDS.......Length+TDc.Functions++++++++++
     D asctime         PR              *   ExtProc('asctime')
     D  tm                                 Const likeDS(TM)

The first parameter is a populated TM data structure value. The TM data structure must be initialized to the desired date and time before calling asctime(). Use time() and localtime() functions to initialize the TM structure, or initialize it yourself before calling this function.

The returned value is a pointer to a character string. The character string contains the date and time formatted for the local system. Use the %STR built-in function to copy the value to a character field. The format of the return value is similar to the following:

Wed Aug 18 09:15:35 2004

CTIME--Get Date/Time as Text

The ctime() procedure returns the character string form of the date and time value stored in the TIME_T parameter value. The TIME_T structure is nothing more than a data structure that contains a single Int4 value. Here's the prototype:

.....DName+++++++++++EUDS.......Length+TDc.Functions+++++++++++++
     D ctime           PR              *   ExtProc('ctime')
     D  time_t                             Const LikeDS(time_t)

The first parameter is the TIME_T structure. This is a character data structure with a single 10i0 (4-byte integer) subfield that contains the date/time value in seconds. Use the time() procedure to retrieve the current TIME_T value.

The returned value is a pointer to a character string. The character string contains the date and time formatted for the local system. Use the %STR built-in function to copy the value to a character field. The format of the return value is similar to the following:

Wed Aug 18 09:15:35 2004

TIME--Get Current System Time in a TIME_T Structure

The time() function returns the current system clock time to a TIME_T structure. Here's the prototype:

.....DName+++++++++++EUDS.......Length+TDc.Functions+++++++++++
     D time            PR                  Extproc('time') 
     D                                       LikeDS(time_t) 
     D  time_t                             LikeDS(time_t) 
     D                                       OPTIONS(*NOPASS)

The first parameter is optional. If specified, it will be set to the same time value as the return value. This allows the function to be called via CALLP or used in an expression. In both cases, the returned value is a TIME_T structure.

LOCALTIME()--Initialize TM Structure with Current Date/Time

The localtime() function converts a TIME_T value (if specified) to a TM structure that can be subsequently used by other C language date/time functions. Here's the prototype:

.....DName+++++++++++EUDS.......Length+TDc.Functions++++++++++++
     D localtime       PR              *   ExtProc('localtime')
     D  time_t                             LikeDS(time_t) 
     D                                     OPTIONS(*NOPASS)

The first parameter is TIME_T structure. This is a character data structure with a single 10i0 (4-byte integer) subfield that contains the date/time value in seconds. This value is converted into a TM structure. Use this function with the time() procedure to retrieve the current time. For example, time(localtime()) returns a TIME_T structure for the current time.

The return value is a pointer to a TM structure. I often use a based data structure to reference the retuned data. For example:

     D  pTM             S                *
     D  myTM            S                   LikeDS(TM) BASED(pTM)

Use this procedure to translate a TIME_T structure to a TM structure value that can be used by the asctime and mktime procedures.

MKTIME--Convert a TM Structure into a TIME_T Structure

The mktime() function is the complement of the LOCALTIME function. It converts a TM structure into a TIME_T value. Here's the prototype:

.....DName+++++++++++EUDS.......Length+TDc.Functions+++++++++++
     D mkTime          PR            10I 0 Extproc('mktime')
     D  TM                                 Like(tm)

The first parameter is an initialized TM structure. The value in the TM structure is converted into a TIME_T integer value and returned.

Several data structures are used as templates for parameters, return values, and other data structures. These templates and data structures are illustrated below.

DIFFTIME--Calculate Difference Between to TIME_T Values

The difftime() procedure returns the number of seconds between the two TIME_T parameters. Here's the prototype:

.....DName+++++++++++EUDS.......Length+TDc.Functions++++++++++++
     D difftime        PR             8F   ExtProc('difftime')
     D  end_time                           Value LikeDS(time_t)
     D  start_time                         Value LikeDS(time_t)

The first parameter is a TIME_T structure that identifies the ending time. The second parameter is a TIME_T structure that identifies the starting time.

The returned value is a double (8F) value that identifies the number of seconds between the two values. To convert this to a more usable value, use the 4-byte binary (10i0) field referencing value:

.....DName+++++++++++EUDS.......Length+TDc.Functions++++_++++++++
0001 D Int4           S              100

The INT4 field is used to allow a 10i0 (4-byte binary) field to be declared "correctly" but with a more precise identification. It is used throughout the examples in this article.

TIME_T Data Structure Template

.....DName+++++++++++EUDS.......Length+TDc.Functions+++++++++++++
0001 D time_t         DS                   QUALIFIED BASED(TMPL_ptr)
0002 D   seconds                           Like(Int4)

The TIME_T data structure contains the date and time in seconds.

TM Data Structure Template

.....DName+++++++++++EUDS.......Length+TDc.Functions+++++++++++++
     D tm              DS                  QUALIFIED BASED(TMPL_ptr)
     D  sec                                Like(int4)
     D  min                                Like(int4)
     D  hour                               Like(int4)
     D  mday                               Like(int4)
     D  mon                                Like(int4)
     D  year                               Like(int4)
     D  wday                               Like(int4)
     D  yday                               Like(int4)
     D  isdst                              Like(int4)

Each subfield of this data structure is a 10i0 value. But since 10i0 is not widely recognized at this point, I've used a field reference to declare each subfield as an INT4 value. The reference field INT4 is declared as a 10i0 value.

The subfields of the TM data structure are described in more detail in the table that follows. Most of these subfields are zero-based, meaning that their values start at zero instead of 1. For example, to specify the month of the year, instead of 1 through 12, you specify 0 through 11 (0 for January, 11 for December).

Subfields of the TM Data Structure
Type
Subfield
Description
10i0 (int)
tm.sec
seconds (0 to 59)
10i0 (int)
tm.min
minutes (0 to 59)
10i0 (int)
tm.hour
hour (0 to 23)
10i0 (int)
tm.mday
day of month (1 to 31)
10i0 (int)
tm.mon
month (0 to 11)
10i0 (int)
tm.year
year minus 1900
(e.g., 78 means 1978)
10i0 (int)
tm.wday
day of week (0 to 6)
10i0 (int)
tm.yday
day of year (0 to 365)
10i0 (int)
tm.isdst
Daylight Savings Time
0 = No daylight savings
1 = Daylight savings
-1 = Unknown

Time Function Summary

Use the time() function to get the current system time into a TIME_T structure. This returns the time in seconds.

Use localtime() to convert a TIME_T structure to a TM structure. Omit the initial time parameter to retrieve the current clock time or use localtime(time()) to get the current system time in a TM structure.

So why do you care about these functions? Well, have you ever needed to figure out the number of years, months, days, hours, minutes, and seconds between two values (or a subset of same)? If so, the traditional RPG IV SUBDUR operation just doesn't cut it. With SUBDUR, you can only get the total number of minutes or seconds or days, etc. But you really want to find out if it has been 2 days, 3 hours, 15 minutes, and 20 seconds. With the difftime() function, you can!

Here's a simple example, in RPG IV, that illustrates how to populate the TM data structure with the number of years, months, days, etc. between two time values.

D  nStartTime      S                   Like(time_t)
D  nEndTime        S                   Like(time_t)
D  nDiff           S                   Like(time_t)
D  pTM             S               *  
D  myTM            S                   LikeDS(TM) BASED(pTM)
C                   eval       nStartTime = Time()
C                   eval       nEndTime = nStartTime + 128333 
C                   eval       nDiff = diffTime(nEndTime:nStartTime)
C                   eval       pTM = LocalTime(nDiff)      

The first Calculation specification retrieves the current time and stores it in a TIME_T variable. After this routine runs, the MYTM data structure is populated with the duration between those two dates, broken down. We can take it further by using SUBDUR on a regular date or date/timestamp value to calculate the number of seconds between two dates; we can then move that result to the nDiff variable and call LOCALTIME.

Bob Cozzi is a programmer/consultant, writer/author, and software developer. His popular RPG xTools add-on subprocedure library for RPG IV is fast becoming a standard with RPG developers. His book The Modern RPG Language has been the most widely used RPG programming book for more than a decade. He, along with others, speaks at and produces the highly popular RPG World conference for RPG programmers.

BOB COZZI

Bob Cozzi is a programmer/consultant, writer/author, and software developer. His popular RPG xTools add-on subprocedure library for RPG IV is fast becoming a standard with RPG developers. His book The Modern RPG Language has been the most widely used RPG programming book for more than a decade. He, along with others, speaks at and produces the highly popular RPG World conference for RPG programmers.


MC Press books written by Robert Cozzi available now on the MC Press Bookstore.

RPG TnT RPG TnT
Get this jam-packed resource of quick, easy-to-implement RPG tips!
List Price $65.00

Now On Sale

The Modern RPG IV Language The Modern RPG IV Language
Cozzi on everything RPG! What more could you want?
List Price $99.95

Now On Sale

BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

$

Book Reviews

Resource Center

  • SB Profound WC 5536 Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application. You can find Part 1 here. In Part 2 of our free Node.js Webinar Series, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Brian will briefly discuss the different tools available, and demonstrate his preferred setup for Node development on IBM i or any platform. Attend this webinar to learn:

  • SB Profound WP 5539More than ever, there is a demand for IT to deliver innovation. Your IBM i has been an essential part of your business operations for years. However, your organization may struggle to maintain the current system and implement new projects. The thousands of customers we've worked with and surveyed state that expectations regarding the digital footprint and vision of the company are not aligned with the current IT environment.

  • SB HelpSystems ROBOT Generic IBM announced the E1080 servers using the latest Power10 processor in September 2021. The most powerful processor from IBM to date, Power10 is designed to handle the demands of doing business in today’s high-tech atmosphere, including running cloud applications, supporting big data, and managing AI workloads. But what does Power10 mean for your data center? In this recorded webinar, IBMers Dan Sundt and Dylan Boday join IBM Power Champion Tom Huntington for a discussion on why Power10 technology is the right strategic investment if you run IBM i, AIX, or Linux. In this action-packed hour, Tom will share trends from the IBM i and AIX user communities while Dan and Dylan dive into the tech specs for key hardware, including:

  • Magic MarkTRY the one package that solves all your document design and printing challenges on all your platforms. Produce bar code labels, electronic forms, ad hoc reports, and RFID tags – without programming! MarkMagic is the only document design and print solution that combines report writing, WYSIWYG label and forms design, and conditional printing in one integrated product. Make sure your data survives when catastrophe hits. Request your trial now!  Request Now.

  • SB HelpSystems ROBOT GenericForms of ransomware has been around for over 30 years, and with more and more organizations suffering attacks each year, it continues to endure. What has made ransomware such a durable threat and what is the best way to combat it? In order to prevent ransomware, organizations must first understand how it works.

  • SB HelpSystems ROBOT GenericIT security is a top priority for businesses around the world, but most IBM i pros don’t know where to begin—and most cybersecurity experts don’t know IBM i. In this session, Robin Tatam explores the business impact of lax IBM i security, the top vulnerabilities putting IBM i at risk, and the steps you can take to protect your organization. If you’re looking to avoid unexpected downtime or corrupted data, you don’t want to miss this session.

  • SB HelpSystems ROBOT GenericCan you trust all of your users all of the time? A typical end user receives 16 malicious emails each month, but only 17 percent of these phishing campaigns are reported to IT. Once an attack is underway, most organizations won’t discover the breach until six months later. A staggering amount of damage can occur in that time. Despite these risks, 93 percent of organizations are leaving their IBM i systems vulnerable to cybercrime. In this on-demand webinar, IBM i security experts Robin Tatam and Sandi Moore will reveal:

  • FORTRA Disaster protection is vital to every business. Yet, it often consists of patched together procedures that are prone to error. From automatic backups to data encryption to media management, Robot automates the routine (yet often complex) tasks of iSeries backup and recovery, saving you time and money and making the process safer and more reliable. Automate your backups with the Robot Backup and Recovery Solution. Key features include:

  • FORTRAManaging messages on your IBM i can be more than a full-time job if you have to do it manually. Messages need a response and resources must be monitored—often over multiple systems and across platforms. How can you be sure you won’t miss important system events? Automate your message center with the Robot Message Management Solution. Key features include:

  • FORTRAThe thought of printing, distributing, and storing iSeries reports manually may reduce you to tears. Paper and labor costs associated with report generation can spiral out of control. Mountains of paper threaten to swamp your files. Robot automates report bursting, distribution, bundling, and archiving, and offers secure, selective online report viewing. Manage your reports with the Robot Report Management Solution. Key features include:

  • FORTRAFor over 30 years, Robot has been a leader in systems management for IBM i. With batch job creation and scheduling at its core, the Robot Job Scheduling Solution reduces the opportunity for human error and helps you maintain service levels, automating even the biggest, most complex runbooks. Manage your job schedule with the Robot Job Scheduling Solution. Key features include:

  • LANSA Business users want new applications now. Market and regulatory pressures require faster application updates and delivery into production. Your IBM i developers may be approaching retirement, and you see no sure way to fill their positions with experienced developers. In addition, you may be caught between maintaining your existing applications and the uncertainty of moving to something new.

  • LANSAWhen it comes to creating your business applications, there are hundreds of coding platforms and programming languages to choose from. These options range from very complex traditional programming languages to Low-Code platforms where sometimes no traditional coding experience is needed. Download our whitepaper, The Power of Writing Code in a Low-Code Solution, and:

  • LANSASupply Chain is becoming increasingly complex and unpredictable. From raw materials for manufacturing to food supply chains, the journey from source to production to delivery to consumers is marred with inefficiencies, manual processes, shortages, recalls, counterfeits, and scandals. In this webinar, we discuss how:

  • The MC Resource Centers bring you the widest selection of white papers, trial software, and on-demand webcasts for you to choose from. >> Review the list of White Papers, Trial Software or On-Demand Webcast at the MC Press Resource Center. >> Add the items to yru Cart and complet he checkout process and submit

  • Profound Logic Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application.

  • SB Profound WC 5536Join us for this hour-long webcast that will explore:

  • Fortra IT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators with intimate knowledge of the operating system and the applications that run on it is small. This begs the question: How will you manage the platform that supports such a big part of your business? This guide offers strategies and software suggestions to help you plan IT staffing and resources and smooth the transition after your AS/400 talent retires. Read on to learn: