24
Wed, Apr
0 New Articles

Day of Week Revisited

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

There are so many APIs available in RPG IV that no one can remember all of them, and several are overlooked. One such API is CEEDYWK. This API is an "ILE built-in." ILE built-in APIs are APIs whose object code is inserted into the compiled object directly.

Normally, a call to an API inserts a call to a routine in a service program or a standalone program. ILE built-ins work a little differently. Rather than insert a call to a subprocedure or program, the actual object code for the API itself is inserted directly inline, into the compiled object. This avoids the overhead of the call.

The prototype for the CEEDYWK API used by the GETDAYOFWEEK subprocedure is listed below:

     D CEEDYWK         PR            10I 0 ExtProc('CEEDYWK') 
     D  nDays                        10I 0 Const 
     D  nRtnDayOfWeek                10I 0

The first parameter of CEEDYWK is the number of days since October 14, 1582. This value may seem a bit odd, but it gives the API a known duration to do its calculation.

The second parameter of CEEDYWK must be a variable that is defined as a 4-byte integer (10i0) value. This variable will receive the day of the week.

To calculate the days since October 14, 1582, use either the SUBDUR opcode or the %DIFF built-in function. For example:

  nDays_Since = %diff(myDate:D'1582-10-14':*DAYS);

The number of days since October 14, 1582, is calculated by passing the date whose day of the week we need to the %DIFF built-in function. The second parameter is the October 14, 1582, date hard-coded.

The third parameter indicates the type of duration being calculated. In this case, the number of days is desired, so *DAYS is specified.

The value returned from this calculation is passed to the CEEDYWK API. The API calculates the day of the week from that value and returns it as a value of 1 to 7 on the second parameter.

The following is a nice little subprocedure called DayOfWeek() that simplifies calling CEEDYWK. Pass in the desired date, and it returns the day of the week.

Here's the prototype:

     D GetDayOfWeek    PR            10I 0
     D  inDate                         D   CONST DATFMT(*ISO)

Here's the procedure implementation:

     P DayOfWeek       B                   EXPORT
     D DayOfWeek       PI            10I 0
     D  inDate                         D   CONST DATFMT(*ISO)

       // Base date is based on date the calendar changed.
     D BaseDate        C                   Const(D'1582-10-14')
     D nDayOfWeek      S             10I 0
      /free 
         ceedywk(%diff(inDate:baseDate:*DAYS) : nDayOfWeek);
         return nDayOfWeek;

      /end-free
     P GetDayOfWeek    E

Certainly the need for the GetDayOfWeek() wrapper subprocedure is debatable. However, it does make for a much cleaner interface. Compare the two ways to call CEEDYWK, first calling it directly and then calling it via the wrapper, as follows:

      /INCLUDE QCPYSRC,ceedywk
     D BaseDate        C                   Const(D'1582-10-14')
     D  myDate         S               D   DATFMT(*ISO) 

     D nDayOfWeek      S             10I 0
      /free 
         myDate = D'2006-12-12';
         ceedywk(%diff(myDate:baseDate:*DAYS) : nDayOfWeek);
      /end-free

In this example, the CEEDYWK prototype is /INCLUDEd into the source, the BASEDATE constant needs to be declared, and then CEEDYWK is called directly, passing the results from the %DIFF() built-in function as the first parameter.

      /COPY QCPYSRC,dates
     D nDayOfWeek      S             10I 0
      /free 
         myDate = D'2006-12-12';
         nDayOfWeek = GetDayOfWeeK(myDate);
      /end-free

In this example, the GetDayOfWeek() subprocedure prototype is /COPYed into the source; then, the GetDayOfWeek() subprocedure is called.

I want to illustrate this technique without all the supporting /COPYs or work fields. Here is the code again, to calculate the day of the week using only the CEEDYWK API without the wrapper subprocedure:

         ceedywk(%diff(myDate:D'1582-10-14':*DAYS) : nDayOfWeek);

And here is the version that uses the API wrapper subprocedure GetDayOfWeek():

         nDayOfWeek = GetDayOfWeeK(myDate);

You have to decide whether you want to start creating a library of usefully subprocedures and API wrappers or whether you want to use the raw API technique. Either method works fine.

Bob Cozzi is a programmer/consultant, writer/author, and software developer of the RPG xTools, a popular add-on subprocedure library for RPG IV. His book The Modern RPG Language has been the most widely used RPG programming book for nearly two decades. He, along with others, speaks at and runs 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

$0.00 Raised:
$

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: