04
Mon, Nov
1 New Articles

TechTalk: Commands with Optional Return Parameter

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

A very useful aspect of the AS/400 and S/38 computers is that they enable you to write your own CL commands. Unfortunately, the documentation is not always clear in explaining the parameters and values of the command definition statements. An example is the return value parameter of the parameter (PARM) command. This parameter allows a command to return a value to the program using it through a CL variable.

The shop where I work keeps a separate database for each location. Normally we use the library list from the user s job description to control which database is accessed; however, programs used by Operations must have the ability to access more than one database. It seemed that we could write a command to retrieve information about a database from a file. That would make it easier to write other programs.

With this approach there would be no need for the programmer to know how the underlying programs worked, and in most cases, they could be changed without changing the programs that used the command. In addition, a CL program can only read one file, and the command would save this resource for some other use, such as a display file.

A problem arises when using return values in a command: they are allowed to be optional parameters. This is great if you only need one or two values to be returned - why clutter the program with variables that will not be used? But what happens in the command processing program (CPP) is that unpassed parameters cause escape message MCH3601 to be issued. The AS/400 text for this message is, "Referenced location in a space that does not contain a pointer." That s it! No suggestions on how to fix it or what it really means. An ancient S/38 user dubbed this the "Confuse Programmer" message. I take it to mean that since parameters are passed by reference instead of by value, what is passed is a pointer to the data. Since nothing has been passed, no pointer has been created. Thus the message.

The good news is that it can be handled by a MONMSG command. What may not be obvious is that when you call a secondary from your CPP, you will have the same problem unless you create a duplicate set of variables to handle any parameters that may not have been specified in the command. By using this technique, you can use CHGVAR to change the duplicate variable to the value of the parameter. You can see this technique at work in Figures 4a through 4d.

A simplified version of our Retrieve Database Attributes (RTVDBATTR) command is shown in 4a. It has one required parameter, ACTION, and four optional parameters that return values - that is, they have RTNVAL (*YES). 4b lists the CPP, which is CL program DB001CL. Notice that parameters DATABASE, JOBD, JOBDLIB, and STATUS have two CL variables each. For instance, parameter JOBD has &PJOBD and &JOBD, both matching the type and length.

A simplified version of our Retrieve Database Attributes (RTVDBATTR) command is shown in Figure 4a. It has one required parameter, ACTION, and four optional parameters that return values - that is, they have RTNVAL (*YES). Figure 4b lists the CPP, which is CL program DB001CL. Notice that parameters DATABASE, JOBD, JOBDLIB, and STATUS have two CL variables each. For instance, parameter JOBD has &PJOBD and &JOBD, both matching the type and length.

First, we issue a CHGVAR to copy &PDATABASE into &DATABASE. Because the DATABASE parameter is optional, however, the statement may receive an MCH3601 message. You can recover by using CHGVAR within a MONMSG, in order to initialize the duplicate variable to some default value before calling the second program, DB001RG, which is shown in 4c.

First, we issue a CHGVAR to copy &PDATABASE into &DATABASE. Because the DATABASE parameter is optional, however, the statement may receive an MCH3601 message. You can recover by using CHGVAR within a MONMSG, in order to initialize the duplicate variable to some default value before calling the second program, DB001RG, which is shown in Figure 4c.

Before returning from the CPP, each parameter variable is changed to the value of its corresponding duplicate and monitored again for MCH3601. Only those passed will be returned and those not passed will have been gracefully ignored.

Program DB002CL (4d) shows an example of using the RTVDBATTR command.

Program DB002CL (Figure 4d) shows an example of using the RTVDBATTR command.

- Joseph Cattano


TechTalk: Commands with Optional Return Parameter

Figure 4A Command RTVDBATTR

 Figure 4a: The RTVDBATTR Command RTVDBATTR: CMD PROMPT( Retrieve Data Base Attributes ) PARM KWD(ACTION) TYPE(*CHAR) LEN(6) RSTD(*YES) + DFT(*FIRST) VALUES(*FIRST *NEXT *PREV + *FIND *CLOSE) PROMPT( Attribute file + action: ) /* The following parameters are optional */ PARM KWD(DATABASE) TYPE(*CHAR) LEN(8) + RTNVAL(*YES) PROMPT( CL var for + database: (8) ) PARM KWD(JOBD) TYPE(*CHAR) LEN(10) RTNVAL(*YES) + PROMPT( CL var for job descript: (10) ) PARM KWD(JOBDLIB) TYPE(*CHAR) LEN(10) + RTNVAL(*YES) PROMPT( CL var for jobd + library: (10) ) PARM KWD(STATUS) TYPE(*CHAR) LEN(9) RTNVAL(*YES) + PROMPT( CL var for command status: (9) ) 
TechTalk: Commands with Optional Return Parameter

Figure 4B CL program DB001CL

 Figure 4b: THE DB001CL Program DB001CL: PGM PARM(&PACTION &PDATABASE &PJOBD &PJOBDLIB + &PSTATUS) /* Parameters */ DCL VAR(&PACTION) TYPE(*CHAR) LEN(6) /* for + file: *FIRST *NEXT *PREV *FIND *CLOSE */ DCL VAR(&PDATABASE) TYPE(*CHAR) LEN(8) /* + Database to perform action on or returned */ DCL VAR(&PJOBD) TYPE(*CHAR) LEN(10) /* Job + description returned */ DCL VAR(&PJOBDLIB) TYPE(*CHAR) LEN(10) /* Job + description library returned*/ DCL VAR(&PSTATUS) TYPE(*CHAR) LEN(9) /* Return + status: *BOF *EOF *FOUND *NOTFOUND */ /* Program variables */ /* Duplicates of return parms above */ DCL VAR(&DATABASE) TYPE(*CHAR) LEN(8) DCL VAR(&JOBD) TYPE(*CHAR) LEN(10) DCL VAR(&JOBDLIB) TYPE(*CHAR) LEN(10) DCL VAR(&STATUS) TYPE(*CHAR) LEN(9) DCL VAR(&MSGID) TYPE(*CHAR) LEN(7) DCL VAR(&MSGDATA) TYPE(*CHAR) LEN(512) MONMSG MSGID(CPF0000 MCH0000) EXEC(GOTO + CMDLBL(ERRORTRAP)) /* Global monitor */ /* With the exception of &PACTION and &PDATABASE, all other + parameters are strictly return variables. &PACTION is + always passed. &PDATABASE may or may not be passed and returned */ CHGVAR VAR(&DATABASE) VALUE(&PDATABASE) MONMSG MSGID(MCH3601) EXEC(CHGVAR VAR(&DATABASE) + VALUE( )) /* Parameter not passed but + needed by the secondary command + processor. */ /* Secondary command processor */ CALL PGM(DB001RG) PARM(&PACTION &DATABASE + &JOBD &JOBDLIB &STATUS) /* Attempt to pass back all return values, but ignore any + parameters that were not specified. */ CHGVAR VAR(&PDATABASE) VALUE(&DATABASE) MONMSG MSGID(MCH3601) CHGVAR VAR(&PJOBD) VALUE(&JOBD) MONMSG MSGID(MCH3601) CHGVAR VAR(&PJOBDLIB) VALUE(&JOBDLIB) MONMSG MSGID(MCH3601) CHGVAR VAR(&PSTATUS) VALUE(&STATUS) MONMSG MSGID(MCH3601) RETURN ERRORTRAP: RCVMSG MSGTYPE(*EXCP) MSGDTA(&MSGDATA) MSGID(&MSGID) SNDPGMMSG MSGID(&MSGID) MSGF(QCPFMSG) MSGDTA(&MSGDATA) + MSGTYPE(*ESCAPE) ENDPGM 
TechTalk: Commands with Optional Return Parameter

Figure 4C RPG program DB001RG

 Figure 4c: The DB001RG Program ....1.... ....2.... ....3.... ....4.... ....5.... ....6.... ....7.... FDBATTR IF E K DISK * PARMs 2 - 4 are filled from this file and are the field names *===============================================================* C *ENTRY PLIST C PARM ACTION 6 C PARM DBASE C PARM JOBD C PARM JOBDLB C PARM STATUS 9 *---------------------------------------------------------------* C MOVEL * STATUS C MOVE FOUND STATUS * C ACTION CASEQ *FIRST FIRST Get first DB rec C ACTION CASEQ *NEXT NEXT Get next DB rec C ACTION CASEQ *PREV PREV Get previous DB C ACTION CASEQ *FIND FIND Find a DB rec C ACTION CASEQ *CLOSE CLOSE Close the file C END C RETRN *===============================================================* C FIRST BEGSR C *LOVAL SETLLDBATTRIB C READ DBATTRIB LR C LR MOVE EOF STATUS C ENDSR *---------------------------------------------------------------* C NEXT BEGSR C READ DBATTRIB 99 C 99 MOVE EOF STATUS C ENDSR *---------------------------------------------------------------* C PREV BEGSR C READPDBATTRIB 99 C 99 MOVE BOF STATUS C ENDSR *---------------------------------------------------------------* C FIND BEGSR C PLT CHAINDBATTRIB 99 C 99 MOVE NOTFOUND STATUS C ENDSR *---------------------------------------------------------------* C CLOSE BEGSR C MOVE EOF STATUS C MOVE 1 *INLR C ENDSR ....1.... ....2.... ....3.... ....4.... ....5.... ....6.... ....7.... 
TechTalk: Commands with Optional Return Parameter

Figure 4D CL program DB002CL

 Figure 4d: The DB002CL Program DB002CL: PGM DCL VAR(&JOBD) TYPE(*CHAR) LEN(10) DCL VAR(&STATUS) TYPE(*CHAR) LEN(9) NEXTDB: RTVDBATTR ACTION(*NEXT) JOBD(&JOBD) STATUS(&STATUS) IF COND(&STATUS = *EOF) THEN(RETURN) SBMJOB JOB(REPORTS) JOBD(&JOBD) RQSDTA( CALL + DBREPORTS ) GOTO CMDLBL(NEXTDB) ENDPGM 
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: