Practical RPG: APIs, Part 1 - Error Handling

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

The more I use APIs, the more I realize how powerful they are, but learning to use them is a process; this article provides a first step.

IBM offers programmers incredible access to the IBM i operating system, but no single avenue is more extensive and powerful than the Application Programming Interface (API) library. So many APIs exist that IBM requires an entire website just to provide access to the documentation. In this article, I'll show you how I've been using this vast resource to advance my application programs.

We'll Begin at the End

Before we start working with specific APIs, I want to cover what might be the most powerful piece of the puzzle: the API error-handling process. For a large percentage of the APIs, IBM provides a very consistent yet flexible way to handle error conditions that supports three techniques, depending on your programming needs. Those three techniques roughly mirror the way we handle errors in CL programming:

  • Just let the error happen (and halt the program).
  • Monitor the error and ignore it.
  • Handle the error with condition-specific programming.

Let's take a look at all of three of these in a specific circumstance. A very common task is to check to see whether an object exists. This is one of those system functions that can be executed either by a CL command or via an API, so it works very well to illustrate the point. Let's start with the appropriate CL code:


With this command, if the file MYFILE does not exist in library MYLIB, an error will occur. What happens next depends on what else you do in your program. If you provide no other programming, the program will halt, sending message CPF9801with the text "Object MYFILE in library MYLIB not found" to the user (or to the system operator in the case of batch jobs). The user can respond to the error message, and the program can continue (or not, depending on the response).

However, you can also do a couple of things to mitigate that hard halt. One is to just follow the CHKOBJ command with the following line of code:


By putting this statement immediately after the CHKOBJ, you will ignore the CPF9801 message. Because I specified CPF0000 (with the four zeros), we'll also ignore any other message starting with CPF. However, ignoring errors is often not a good idea, so let's see the third case:


MONMSG     MSGID(CPF9801) EXEC(DO)        



In this case, we check for a specific error, and if it occurs, then we do something in response; in this case, if the file is not found, we create it. Because we coded the specific message ID (CPF9801) in the MSGID keyword, any other errors will actually halt just as if we hadn't coded a MONMSG at all. You can instead follow this with more MONMSG instructions to handle other errors and then finally with generic handlers such as MONMSG MSGID(CPF0000) to handle unexpected errors. Hopefully, this is just review; it's just meant to get us to the API programming. If you're unfamiliar with this subject matter, you can learn more about CL programming through books such as Ted Holt's masterpiece, Complete CL, available from our own wonderful MC Press.

Handling Errors in APIs

As I've said already, the majority of IBM i APIs use the standard API error technique. Notable exceptions include the UNIX-type APIs such as system and iconv, which use the errno value to indicate the error. I'll discuss that in a different article that will focus on the UNIX-type APIs. Today, though, we will review the standard API error structure. Let's take a look at just the API error structure itself. It has three variations:

      dcl-ds ApiThrow;

      *n int(10) inz(0);

      *n int(10) inz(0);


     dcl-ds ApiIgnore qualified;

      BytPrv int(10) inz(8);

      BytAvl int(10) inz(0);


     dcl-ds ApiError qualified;

      BytPrv   int(10) inz(%size(ApiError));

      BytAvl   int(10) inz(0);

      MsgID   char(7);

      reserved char(1);

      MsgDta   char(80);


The third iteration (ApiError) is the most flexible; it is set up to return the error message data. If your command fails, the error message ID and message data will be returned in the MsgID and MsgDta fields, respectively, in the ApiError data structure. We'll look at that one in a moment. But first let's discuss ApiIgnore and ApiThrow. These are the shortcut structures; each is only eight bytes long. The first four bytes tells the API how much error information you want returned, while the second are used by the API to communicate whether an error occurred. If you pass zero in the first bytes (as is done in ApiThrow), then any error causes a halt. If, on the other hand, you pass a value of exactly 8 (eight), then an error will not cause a halt, but a non-zero value will be returned in the second four bytes. Please note that the subfields BytPrv (bytes provided) and BytAvl (bytes available) exist in both ApiError and ApiIgnore, which is why I use the qualified modifier. I'll leave it as a reader exercise to determine why I didn't specify qualified for ApiThrow.

Returning to ApiError, you'll see that it uses a different technique for the first value. The BytPrv field is initialized to the size of the overall ApiError data structure. This would change based on, for example, the length of the MsgDta field. And that's exactly what we use it for: to return a larger (or smaller) amount of message data. We'll see how all this works in the next section.

Calling an API

It's time to call an API. Two APIs exist that provide similar functionality to CHKOBJ. One is QSYCUSRA, which checks the authority, but for those cases when all you're doing is checking the existence of the object, QUSROBJD is a better fit. It simply retrieves the object description, but it returns an error if the object is not found. The prototype for the call is pretty standard: there's a data structure that defines the data returned, and a call. Here's the free-format definition:

      dcl-ds OBJD0100 qualified;

      BytRet   int(10);

      BytAvl   int(10);

      ObjNam   char(10);

      ObjLib   char(10);

      ObjTyp   char(10);

      RtnLib   char(10);

      ASP     int(10);

      ObjOwn   char(10);

      ObjDom   char(2);

      ObjCrt   char(13);

      ObjChg   char(13);


     dcl-pr QUSROBJD extpgm;

      iData   like(OBJD0100);

      iDataLen int(10) const;

      iFormat char(10) const;

      iObjlib char(20) const;

      iType   char(10) const;

      iError   char(1) options(*varsize);


You see the OBJD0100 data structure, which contains the data that we'll be returning. Like many other APIs, the QUSROBJD API can return data in multiple formats. The format used is determined by one of the parameters passed into the API. In this case, the iFormat parameter identifies which format to use. Other formats return more data; you can see more about them and the QUSROBJD API in general on the IBM website. Today we're just going to focus on the last parameter in the prototype, iError.

Since we may pass parameters of different lengths to this API depending on the kind of error-handling we need, the correct prototype definition is to use options(*varsize) as part of the subfield definition. This causes the compiler to ignore the length check and basically allows you to pass any size of parameter. This means that you and the API have to somehow agree on the length of the parameter. In the case of the ApiError structure, it's done in those first four bytes that are initialized with %size(ApiError). So let's write the actual program that uses all of this:

      dcl-pi *n;

      iLib char(10);

      iObj char(10);

      iTyp char(10);



      OBJD0100: %size(OBJD0100): 'OBJD0100': iObj+iLib: iTyp: ApiError);


      OBJD0100: %size(OBJD0100): 'OBJD0100': iObj+iLib: iTyp: ApiIgnore);


      OBJD0100: %size(OBJD0100): 'OBJD0100': iObj+iLib: iTyp: ApiThrow);

     *inlr = *on;


As you can see, after setting up the prototypes and structure, the code is actually very straightforward. You can refer to the website for a more in-depth explanation of the parameters that I need to pass in, but I can describe them briefly here. The first three identify the receiver variable: the variable itself, the size of the variable, and the format, OBJD0100. The next two are the input parameters for the actual object. The first is the standard IBM construct for a qualified object, which is the 10-character object name and the 10-character library name concatenated into one 20-character field. Next is the object type. Finally, we include the (optional) error-handling structure. I have three different calls using the same values, just with different error handling.

You can now copy all the code above into an RPGLE member and compile it and call the program to see how each works. The first uses ApiError, which returns the message ID and data. In fact, if I call the program with an object that doesn't exist, I can see the following data in ApiError when using the debugger:

EVAL apierror                      

APIERROR.BYTPRV = 96              

APIERROR.BYTAVL = 36              

APIERROR.MSGID = 'CPF9811'        

APIERROR.RESERVED = '0'            

APIERROR.MSGDTA =                  


     1   'NOOBJECT QGPL          

Each subsequent call acts differently. The second call returns nothing except the value 36 in the second parameter. This is the indication that an error occurred. And finally, the third call causes the error to be thrown back to the program, and I get a hard halt saying the call failed (as well as seeing the CPF9811 error in the joblog).

More to Come

Today's article is just an introduction to the universe of API programming. You can find a wealth of great information online, including the fantastic IBM System i APIs at Work book, also available here at MC Press. In upcoming articles, I'll be introducing you to other APIs, along with techniques I happily incorporated from the work of others, including Carsten Flensberg's incredible website, APIs My My My.


Joe Pluta

Joe Pluta is the founder and chief architect of Pluta Brothers Design, Inc. He has been extending the IBM midrange since the days of the IBM System/3. Joe uses WebSphere extensively, especially as the base for PSC/400, the only product that can move your legacy systems to the Web using simple green-screen commands. He has written several books, including Developing Web 2.0 Applications with EGL for IBM i, E-Deployment: The Fastest Path to the Web, Eclipse: Step by Step, and WDSC: Step by Step. Joe performs onsite mentoring and speaks at user groups around the country. You can reach him at

MC Press books written by Joe Pluta available now on the MC Press Bookstore.

Developing Web 2.0 Applications with EGL for IBM i Developing Web 2.0 Applications with EGL for IBM i
Joe Pluta introduces you to EGL Rich UI and IBM’s Rational Developer for the IBM i platform.
List Price $39.95

Now On Sale

WDSC: Step by Step WDSC: Step by Step
Discover incredibly powerful WDSC with this easy-to-understand yet thorough introduction.
List Price $74.95

Now On Sale

Eclipse: Step by Step Eclipse: Step by Step
Quickly get up to speed and productivity using Eclipse.
List Price $59.00

Now On Sale

More Articles By This Author
Related Articles


Support MC Press Online





  • White Paper: Node.js for Enterprise IBM i Modernization

    SB Profound WP 5539

    If your business is thinking about modernizing your legacy IBM i (also known as AS/400 or iSeries) applications, you will want to read this white paper first!

    Download this paper and learn how Node.js can ensure that you:
    - Modernize on-time and budget - no more lengthy, costly, disruptive app rewrites!
    - Retain your IBM i systems of record
    - Find and hire new development talent
    - Integrate new Node.js applications with your existing RPG, Java, .Net, and PHP apps
    - Extend your IBM i capabilties to include Watson API, Cloud, and Internet of Things

    Read Node.js for Enterprise IBM i Modernization Now!


  • Profound Logic Solution Guide

    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 companyare not aligned with the current IT environment.

    Get your copy of this important guide today!


  • 2022 IBM i Marketplace Survey Results

    Fortra2022 marks the eighth edition of the IBM i Marketplace Survey Results. Each year, Fortra captures data on how businesses use the IBM i platform and the IT and cybersecurity initiatives it supports.

    Over the years, this survey has become a true industry benchmark, revealing to readers the trends that are shaping and driving the market and providing insight into what the future may bring for this technology.

  • Brunswick bowls a perfect 300 with LANSA!

    FortraBrunswick is the leader in bowling products, services, and industry expertise for the development and renovation of new and existing bowling centers and mixed-use recreation facilities across the entertainment industry. However, the lifeblood of Brunswick’s capital equipment business was running on a 15-year-old software application written in Visual Basic 6 (VB6) with a SQL Server back-end. The application was at the end of its life and needed to be replaced.
    With the help of Visual LANSA, they found an easy-to-use, long-term platform that enabled their team to collaborate, innovate, and integrate with existing systems and databases within a single platform.
    Read the case study to learn how they achieved success and increased the speed of development by 30% with Visual LANSA.


  • Progressive Web Apps: Create a Universal Experience Across All Devices

    LANSAProgressive Web Apps allow you to reach anyone, anywhere, and on any device with a single unified codebase. This means that your applications—regardless of browser, device, or platform—instantly become more reliable and consistent. They are the present and future of application development, and more and more businesses are catching on.
    Download this whitepaper and learn:

    • How PWAs support fast application development and streamline DevOps
    • How to give your business a competitive edge using PWAs
    • What makes progressive web apps so versatile, both online and offline



  • The Power of Coding in a Low-Code Solution

    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:

    • Discover the benefits of Low-code's quick application creation
    • Understand the differences in model-based and language-based Low-Code platforms
    • Explore the strengths of LANSA's Low-Code Solution to Low-Code’s biggest drawbacks



  • Why Migrate When You Can Modernize?

    LANSABusiness 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.
    In this white paper, you’ll learn how to think of these issues as opportunities rather than problems. We’ll explore motivations to migrate or modernize, their risks and considerations you should be aware of before embarking on a (migration or modernization) project.
    Lastly, we’ll discuss how modernizing IBM i applications with optimized business workflows, integration with other technologies and new mobile and web user interfaces will enable IT – and the business – to experience time-added value and much more.


  • UPDATED: Developer Kit: Making a Business Case for Modernization and Beyond

    Profound Logic Software, Inc.Having trouble getting management approval for modernization projects? The problem may be you're not speaking enough "business" to them.

    This Developer Kit provides you study-backed data and a ready-to-use business case template to help get your very next development project approved!

  • What to Do When Your AS/400 Talent Retires

    FortraIT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators is small.

    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:

    • Why IBM i skills depletion is a top concern
    • How leading organizations are coping
    • Where automation will make the biggest impact


  • Node.js on IBM i Webinar Series Pt. 2: Setting Up Your Development Tools

    Profound Logic Software, Inc.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. In Part 2, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Attend this webinar to learn:

    • Different tools to develop Node.js applications on IBM i
    • Debugging Node.js
    • The basics of Git and tools to help those new to it
    • Using as a pre-built development environment



  • Expert Tips for IBM i Security: Beyond the Basics

    SB PowerTech WC GenericIn this session, IBM i security expert Robin Tatam provides a quick recap of IBM i security basics and guides you through some advanced cybersecurity techniques that can help you take data protection to the next level. Robin will cover:

    • Reducing the risk posed by special authorities
    • Establishing object-level security
    • Overseeing user actions and data access

    Don't miss this chance to take your knowledge of IBM i security beyond the basics.



  • 5 IBM i Security Quick Wins

    SB PowerTech WC GenericIn today’s threat landscape, upper management is laser-focused on cybersecurity. You need to make progress in securing your systems—and make it fast.
    There’s no shortage of actions you could take, but what tactics will actually deliver the results you need? And how can you find a security strategy that fits your budget and time constraints?
    Join top IBM i security expert Robin Tatam as he outlines the five fastest and most impactful changes you can make to strengthen IBM i security this year.
    Your system didn’t become unsecure overnight and you won’t be able to turn it around overnight either. But quick wins are possible with IBM i security, and Robin Tatam will show you how to achieve them.

  • Security Bulletin: Malware Infection Discovered on IBM i Server!

    SB PowerTech WC GenericMalicious programs can bring entire businesses to their knees—and IBM i shops are not immune. It’s critical to grasp the true impact malware can have on IBM i and the network that connects to it. Attend this webinar to gain a thorough understanding of the relationships between:

    • Viruses, native objects, and the integrated file system (IFS)
    • Power Systems and Windows-based viruses and malware
    • PC-based anti-virus scanning versus native IBM i scanning

    There are a number of ways you can minimize your exposure to viruses. IBM i security expert Sandi Moore explains the facts, including how to ensure you're fully protected and compliant with regulations such as PCI.



  • Encryption on IBM i Simplified

    SB PowerTech WC GenericDB2 Field Procedures (FieldProcs) were introduced in IBM i 7.1 and have greatly simplified encryption, often without requiring any application changes. Now you can quickly encrypt sensitive data on the IBM i including PII, PCI, PHI data in your physical files and tables.
    Watch this webinar to learn how you can quickly implement encryption on the IBM i. During the webinar, security expert Robin Tatam will show you how to:

    • Use Field Procedures to automate encryption and decryption
    • Restrict and mask field level access by user or group
    • Meet compliance requirements with effective key management and audit trails


  • Lessons Learned from IBM i Cyber Attacks

    SB PowerTech WC GenericDespite the many options IBM has provided to protect your systems and data, many organizations still struggle to apply appropriate security controls.
    In this webinar, you'll get insight into how the criminals accessed these systems, the fallout from these attacks, and how the incidents could have been avoided by following security best practices.

    • Learn which security gaps cyber criminals love most
    • Find out how other IBM i organizations have fallen victim
    • Get the details on policies and processes you can implement to protect your organization, even when staff works from home

    You will learn the steps you can take to avoid the mistakes made in these examples, as well as other inadequate and misconfigured settings that put businesses at risk.



  • The Power of Coding in a Low-Code Solution

    SB PowerTech WC GenericWhen 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:

    • Discover the benefits of Low-code's quick application creation
    • Understand the differences in model-based and language-based Low-Code platforms
    • Explore the strengths of LANSA's Low-Code Solution to Low-Code’s biggest drawbacks



  • Node Webinar Series Pt. 1: The World of Node.js on IBM i

    SB Profound WC GenericHave 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.
    Part 1 will teach you what Node.js is, why it's a great option for IBM i shops, and how to take advantage of the ecosystem surrounding Node.
    In addition to background information, our Director of Product Development Scott Klement will demonstrate applications that take advantage of the Node Package Manager (npm).
    Watch Now.

  • The Biggest Mistakes in IBM i Security

    SB Profound WC Generic The Biggest Mistakes in IBM i Security
    Here’s the harsh reality: cybersecurity pros have to get their jobs right every single day, while an attacker only has to succeed once to do incredible damage.
    Whether that’s thousands of exposed records, millions of dollars in fines and legal fees, or diminished share value, it’s easy to judge organizations that fall victim. IBM i enjoys an enviable reputation for security, but no system is impervious to mistakes.
    Join this webinar to learn about the biggest errors made when securing a Power Systems server.
    This knowledge is critical for ensuring integrity of your application data and preventing you from becoming the next Equifax. It’s also essential for complying with all formal regulations, including SOX, PCI, GDPR, and HIPAA
    Watch Now.

  • Comply in 5! Well, actually UNDER 5 minutes!!

    SB CYBRA PPL 5382

    TRY 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.

    Request your trial now!

  • Backup and Recovery on IBM i: Your Strategy for the Unexpected

    FortraRobot automates the routine 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:
    - Simplified backup procedures
    - Easy data encryption
    - Save media management
    - Guided restoration
    - Seamless product integration
    Make sure your data survives when catastrophe hits. Try the Robot Backup and Recovery Solution FREE for 30 days.

  • Manage IBM i Messages by Exception with Robot

    SB HelpSystems SC 5413Managing messages on your IBM i can be more than a full-time job if you have to do it manually. 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:
    - Automated message management
    - Tailored notifications and automatic escalation
    - System-wide control of your IBM i partitions
    - Two-way system notifications from your mobile device
    - Seamless product integration
    Try the Robot Message Management Solution FREE for 30 days.

  • Easiest Way to Save Money? Stop Printing IBM i Reports

    FortraRobot 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:

    - Automated report distribution
    - View online without delay
    - Browser interface to make notes
    - Custom retention capabilities
    - Seamless product integration
    Rerun another report? Never again. Try the Robot Report Management Solution FREE for 30 days.

  • Hassle-Free IBM i Operations around the Clock

    SB HelpSystems SC 5413For over 30 years, Robot has been a leader in systems management for IBM i.
    Manage your job schedule with the Robot Job Scheduling Solution. Key features include:
    - Automated batch, interactive, and cross-platform scheduling
    - Event-driven dependency processing
    - Centralized monitoring and reporting
    - Audit log and ready-to-use reports
    - Seamless product integration
    Scale your software, not your staff. Try the Robot Job Scheduling Solution FREE for 30 days.