29
Fri, Nov
0 New Articles

RPG Academy: Parameters: What You Should Know, Part 1

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

 

Previous TechTips described procedures and functions. Now it's time to talk a bit about parameters. Read on to find out more!

 

We talked about procedures and functions, describing them as something similar to subroutines with parameters. So let's talk about those parameters: how they work, how to best use them, and other interesting facts.

 

There are multiple ways to pass information from one program to another program. You can exploit the LDA, use a temporary file, or pass parameters, just to name a few. Some methods are easier to implement and maintain than others because they're more explicit and "debuggable." Passing parameters is, in my opinion, the best solution in the vast majority of situations: parameters are easy to use, they're efficient (because only the memory address is passed to the called program, the amount of data being passed is minimal, thus making the data access operation more efficient), and you can access their contents in a straightforward manner when you're debugging.

 

However, there are some pitfalls. Have you ever had that weird situation where something is changing a variable but you can't figure out what it is? Then, after some frustrating (and sometimes infuriating) investigation, you discover that the value of the variable got changed by a program call that used that variable as a parameter. Been there? I have. This happens because, by default, parameters are passed by reference. This means that you actually pass the reference (or memory pointer) of the parameter to the program you're calling. As that program runs, it may change the contents of the parameter and, since it's using the actual memory slot that the variable is stored in, return a wrong value to the calling program. Calling a program in OPM or ILE will always pass the parameter by reference, but when you're calling an ILE procedure or function, you can specify how the parameters should be handled: by reference (the default by omission) or by value. This second option means that the value of the variable, not the memory pointer, is passed to the procedure, so there's no risk of the original variable value being changed. You might say, "Wow! That seems great, but how do I do it?" Well, I've shown it already a couple of times in other TechTips of this series. Let's use the previous TechTip's USD_To_Eur function as an example:

 

*-------------------------------------------------------------------------*

*   Convert USD to Eur at the current exchange rate    

*-------------------------------------------------------------------------*

 

P USD_to_Eur     B                   EXPORT                      

D                 PI           11 2                          

D P_USD_Amt                   11 2 Value                          

 

Notice the Value keyword that's in the P_USD_Amt line. That keyword means that the USD_to_Eur function may use the parameter freely, because when the function call ends, the value of the variable P_USD_Amt in the calling program will remain unchanged. This is also a simple way to separate the input and output parameters of a procedure. I usually use the Value keyword in the input parameters, not only because their value remains unchanged but also because it makes the code more readable: with just a quick look at the procedure interface, I can easily determine which are the input and output parameters of the procedure.

 

However, as with everything in life, there are exceptions: Sometimes, you'll need to perform mostly the same operations but with slight differences. Imagine, for instance, that you need to convert USD to Eur, as in the previous TechTip example, but you'd also like to specify a date in order to get that day's conversion rate instead of the latest available. It seems simple enough: Just add a reference date parameter to the USD_to_Eur function, right? Well, then you'd have to check whether something was passed, whether that something is indeed a valid date, and whether it's supposed to be used. This last part can be tricky: Zero is not a valid date, but it might be a way to "tell" the function to use the latest available exchange rate. It's obviously possible (and this is a simplistic example), but there's a simpler way: If you don't want to specify a reference date, just don't! OK, now the call to the function causes a compilation error because you didn't specify enough parameters. There's a solution for this scenario: Use the OPTIONS(*NOPASS) keyword. The new procedure interface would look like this:

 

*-------------------------------------------------------------------------*

*   Convert USD to Eur at the current exchange rate    

*-------------------------------------------------------------------------*

 

P USD_to_Eur     B                   EXPORT          

D                 PI           11 2                  

D P_USD_Amt                   11 2 Value              

D P_Ref_Date                   8 0 OPTIONS(*NOPASS)

 

Then the function's code would have to determine how many parameters were passed, in order to execute the appropriate code. That would be achieved with the %Parms BIF. %Parms returns the number of parameters that were passed. Here's how to use it:

 

C                  If       %Parms = 2

* The reference date was passed,

* So get the exchange rate for that date

*                (some code here)

C                   Else

* Only the USD amount parameter was passed,

* So get the latest exchange rate available

*                (some other code here)

 

C                   EndIf

* Now that the exchange rate is set, do the conversion

*                 (some more code here)

 

 

You have to follow a couple of rules when using the *NOPASS option:

  • Adapt your code to cope with the number of parameters that were passed, using the %Parms BIF. If you try to use a parameter that was not passed, you'll get a "pointer not set" error and the program will crash.
  • All the parameters specified after the first parameter with *NOPASS also have to have that keyword. This requirement can be annoying when you have multiple parameters and just want to pass the last one, but there's a solution for it! I'll discuss it in the next TechTip.

 

That's all for now! The next TechTip will continue to discuss parameters, picking up where this one left off.

Rafael Victoria-Pereira

Rafael Victória-Pereira has more than 20 years of IBM i experience as a programmer, analyst, and manager. Over that period, he has been an active voice in the IBM i community, encouraging and helping programmers transition to ILE and free-format RPG. Rafael has written more than 100 technical articles about topics ranging from interfaces (the topic for his first book, Flexible Input, Dazzling Output with IBM i) to modern RPG and SQL in his popular RPG Academy and SQL 101 series on mcpressonline.com and in his books Evolve Your RPG Coding and SQL for IBM i: A Database Modernization Guide. Rafael writes in an easy-to-read, practical style that is highly popular with his audience of IBM technology professionals.

Rafael is the Deputy IT Director - Infrastructures and Services at the Luis Simões Group in Portugal. His areas of expertise include programming in the IBM i native languages (RPG, CL, and DB2 SQL) and in "modern" programming languages, such as Java, C#, and Python, as well as project management and consultancy.


MC Press books written by Rafael Victória-Pereira available now on the MC Press Bookstore.

Evolve Your RPG Coding: Move from OPM to ILE...and Beyond Evolve Your RPG Coding: Move from OPM to ILE...and Beyond
Transition to modern RPG programming with this step-by-step guide through ILE and free-format RPG, SQL, and modernization techniques.
List Price $79.95

Now On Sale

Flexible Input, Dazzling Output with IBM i Flexible Input, Dazzling Output with IBM i
Uncover easier, more flexible ways to get data into your system, plus some methods for exporting and presenting the vital business data it contains.
List Price $79.95

Now On Sale

SQL for IBM i: A Database Modernization Guide SQL for IBM i: A Database Modernization Guide
Learn how to use SQL’s capabilities to modernize and enhance your IBM i database.
List Price $79.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: