Writing a procedure can be fun, as I showed you in my article "Let's Build a Procedure." But getting started can be confusing and a little scary. In this short article, I'll show you how to add a procedure to an existing RPG IV program.
First, even though RPG IV's implementation of an ILE procedure is called a "subprocedure," subprocedures are not similar to subroutines. Subroutines have limitations but are faster to call. They are faster to call because there is no call; there's simply a GOTO (under the covers), and the subroutine is entered. A subprocedure, on the other hand, is much more powerful but can be as simple as a subroutine.
Let's consider a very easy subroutine, one line that simply converts a character variable to uppercase. I'm calling it MAKEUPPER.
The MAKEUPPER subroutine is called after a user enters search criteria for a customer name. The customer file is read, and the customer's name is converted to uppercase and then compared to the data the user entered. We use a case-insensitive compare to simplify the search.
Here's an example of that routine:
D upper C 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
C EXFMT PromptUser
// Additional code goes here...
C Read CustMast
C if Not %EOF()
C eval Work1 = CustName
C exsr MakeUpper
C if Work1 = SearchName
C exsr FoundMatch
C endif
C endif
//////////////////////////////////////////
// Convert the field named
// WORK1 to uppercase.
//////////////////////////////////////////
CSR MakeUpper BegSR
C lower:UPPER XLATE Work1 Work1
CSR EndMakeUpper EndSR
All RPG programmers have used subroutines, and the subroutine illustrated above should be very easy to understand.
To convert this subroutine to a subprocedure is very easy. You simply create the procedure around the existing subroutine.
So this...
// Convert the field named
// WORK1 to uppercase.
//////////////////////////////////////////
CSR MakeUpper BegSR
C lower:UPPER XLATE Work1 Work1
CSR EndMakeUpper EndSR
...turns into this:
D MakeUpper PI
D inputVar Like(CUSTNAME)
D OutputVar Like(CUSTNAME)
D lower C 'abcdefghijklmnopqrstuvwxyz'
D upper C 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
C lower:UPPER XLATE InputVar OutputVar
C return
P MakeUpper E
In this example, the procedure named MAKEUPPER is declared. The first and last lines of the example are P-specs (Procedure specifications). These are similar to the BEGSR and ENDSR opcodes; they isolate the procedure.
Unlike subroutines, subprocedures can have parameters. This makes them more like a program than a subroutine. Our MAKEUPPER subprocedure has two parameters: INPUTVAR and OUTPUTVAR. The attributes of parameters are specified in much the same way data structure subfields are specified. In our example, I use the LIKE keyword to define the parameters the same way I define the customer name field (lines 3 and 4).
As with programs, the values of subprocedure parameters may be modified, and those modified values are sent back to the caller. In fact, as with programs, when you change a parameter in a subprocedure, you are actually changing the memory assigned to the variable you passed in. But you have a few more advanced options when passing parameters to subprocedures. For example, you can declare a parameter in such as way that it cannot be changed by the subprocedure. You can also declare it so that the parameter can be passed with a different size or length than that of the parameter definition.
Since subprocedures are similar to little programs, they can have their own fields, known as "local variables." These variables exist only while the subprocedure's Calc specs are being performed. When the procedure returns to the caller, the variables go away. Again, this is similar to setting on LR and returning from a program.
In our example, no local variables are declared; however, some local named constants (lines 5 and 6) are declared. These local values can be used only from within this subprocedure.
The Calc specs are fairly straightforward: Perform the XLATE opcode and return to the caller. The RETURN opcode is optional in this situation, but it is good style to always include it.
Our original example modified to call a subprocedure would look like this:
// Additional code goes here...
C Read CustMast
C if Not %EOF()
C callp MakeUpper(CustName:Work1)
C if Work1 = SearchName
C exsr FoundMatch
C endif
C endif
P MakeUpper B
D MakeUpper PI
D inputVar Like(CUSTNAME)
D OutputVar Like(CUSTNAME)
D lower C 'abcdefghijklmnopqrstuvwxyz'
D upper C 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
C lower:UPPER XLATE InputVar OutputVar
C return
P MakeUpper E
One Final Piece
For many RPG programmers, one of the barriers to using subprocedures is something called "prototyping." Prototyping is required and is simply the subprocedure equivalent to a parameter list. Unlike program-to-program calls, which allow an ad hoc parameter list to be specified immediately following the CALL opcode, subprocedures require a named parameter list. This named parameter list is referred to as a prototype. In fact, even if the subprocedure does not have parameters, a prototype is necessary.
In most situations, the prototype is identical to the entry parameter list of the subprocedure. In our example, the entry parameter list is as follows:
D inputVar Like(CUSTNAME)
D OutputVar Like(CUSTNAME)
To create a prototype for this entry parameter list, all you have to do is copy these three statements and change the letters "PI" (which stand for procedure interface) to the letters "PR" (which stand for prototype). Here's what it will look like:
D inputVar Like(CUSTNAME)
D OutputVar Like(CUSTNAME)
This three-line prototype needs to be copied up to the D-specs of your program/source member--not the ones inside a subprocedure, but the main D-specs up at the top of the source member. These D-specs are referred to as "global variables or global declarations." Prototypes need to be global in order to use them in the mainline Calcs of your programs. Prototypes also cause no additional overhead, nor do they take up space in the compiled objects. They are there only to help the compiler determine if you specified the proper syntax (that is, the correct parameter list) for the procedure you are calling.
So that's it. You can now convert a subroutine to a subprocedure with or without parameters.
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 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 Get this jam-packed resource of quick, easy-to-implement RPG tips! List Price $65.00 Now On Sale
|
|
||
 |
|
The Modern RPG IV Language Cozzi on everything RPG! What more could you want? List Price $99.95
Now On Sale
|
More 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.
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. Make sure your data survives when catastrophe hits. Request your trial now! Request Now.
Forms 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.
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:
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.
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:
LATEST COMMENTS
MC Press Online