Return Number of Parameters (%PARMS) and Parameter Number (%PARMNUM) - IBM i

Return Number of Parameters (%PARMS)

Built-In Function %PARMS returns the number of parameters passed to the procedure where %PARMS is run. 

This BIF is useful when the procedure contains multiple optional parameters and if the procedure is called from different places with different number of parameters to identify the number of parameters passed. 

This is most commonly used to to handle the procedure logic based on the parameters passed only. 

Value returned by %PARMS is same as *PARMS in Program Status Data Structure if used in the main procedure. 

Let's have a look at the simple example to see how this works. 

%PARMS - RPGLE

In the above example, 
  • Lines - 5 to 9: Prototype declaration of the Sub procedure with one mandatory parameter, two optional parameters and one return value. We will see the code of procedure in a bit. 
  • Line - 18, 22 & 26: Calling the sub procedure with one mandatory parameter, two parameters and three parameters respectively. 
Let's have a look at the code for Sub procedure and see how the %PARMS work. 

%PARMS - RPGLE

In the above procedure, 
  • Lines 42 & 44: We are using %PARMS to determine the number of parameters passed. 
This is often used to handle the parameters (like initializing or making sure these aren't used in the logic etc) that are not passed and make sure the procedure works as expected. 

One thing to note here here, If the RTNPARM keyword is used return parameter would be considered as one of the (first) parameter and total number of parameters would be increased by 1. 

In the above example, If only one parameter is passed, %Parms would be 2 (by considering the return parameter). 

%PARMS with RTNPARM- RPGLE

In the above example, 
  • Line - 34: We are using RTNPARM keyword against the Procedure Interface. The same would need to mentioned in the Prototype as well. 
  • Lines - 42, 44 & 46: We are using %PARMS to check the number of parameters by considering the return parameter. 
    • %PARMS would be 2 if only one parameter is passed.
    • %PARMS would be 3 if two parameters are passed. 
    • %PARMS would be 4 if three parameters are passed. 

Return Parameter Number (%PARMNUM)

Built-In Function %PARMNUM returns the number of the parameter passed from the parameters list. 

Operand for this BIF should always be the parameter specified in the procedure interface. 

Below are the few important points to remember. 
  • %PARMNUM can only be used with the parameters defined in Procedure Interface (PI) and Parameter defined using PLIST cannot be used.
  • Parameter Name must be specified as it is defined in the PI. 
    • If the parameter is an array, Array should be used and not an Index. 
    • If the parameter is a data structure, Data structure should be used and not subfields.
    • If the parameter is a file, File should be used and not record format. 
  • If RTNPARM is used, Return value is considered as the first parameter and the other parameters would be considered next.
Let's have a look at an example without using RTNPARM first to understand how this works. 

PARMNUM - RPGLE

In the above example, 
  • Line - 34: Procedure Interface is defined without RTNPARM. 
  • Lines - 43, 46 & 49: %PARMNUM is used to get the parameter number passed. 
    • Only Parameter names from the Procedure Interface are to be used. 
  • Line - 52: %PARMS is used to return the total number of parameters passed. 
Similar to %PARMS, If we use RTNPARM total number of parameters would be increased by 1 and parameter number also would be increased by 1 as the return value is considered as first parameter. 

Let's add RTMPARM to the above procedure. 

PARMNUM with RTNPARM - RPGLE

By adding RTNPARM to the Procedure Interface, Number of the parameter and total number of parameters passed are increased by 1. 


If you have any Suggestions or Feedback, Please leave a comment below or use Contact Form. 

Comments

Post a Comment

Popular posts from this blog

What is the importance of User Open (USROPN) in RPGLE - IBM i

User Open (USROPN) USROPN (User Open) in RPGLE provides the flexibility for the programmer to open a file at a specific point in the program execution. In this post, let's explore what is the use of a USROPN and what is the importance of USROPN and how to use it with a simple example. What is the use of USROPN? By default, any file in the RPGLE (defined in F-Spec) opens as soon as the program execution is started and file is closed at the end of the program (by setting LR indicator ON). A simple RPGLE program looks something like this on a high level with out the use of a USROPN.  1 2 3 4 5 6 7 8 9 10 11 **Free                                  Dcl-F TestFile;                            ...
Read more

What is Deep Learning? Beyond the Basics of AI

What is Deep Learning? Beyond the Basics of AI AI’s everywhere—unlocking your phone, suggesting playlists, even driving cars. But how does it get *so* smart? Enter deep learning—a game-changer in artificial intelligence. Welcome to Decoding Complexities , where we unravel tech’s toughest puzzles. If you read “What Are Neural Networks?” you’ve brushed against this. Now, we’re going deeper. In this post, we’ll decode what deep learning is, how it powers AI’s wildest feats, and why it’s more than just buzz. From self-driving Teslas to ChatGPT, it’s the engine behind the magic. Let’s break it down—ready? Deep Learning: The Basics Deep learning (DL) is a subset of machine learning—itself a chunk of AI. Remember neural networks from my last post? DL cranks them up—think neural networks on steroids. It’s all about *deep* neural networks—piles of layers that dig into data to find patterns no human could spot. Here’s the gist: More Layers: Regula...
Read more

What is Artificial Intelligence?

Artificial Intelligence Artificial Intelligence (In short, AI) is a highly sought-after skill in the Tech Industry today. In this post, let's try to understand " What is Artificial Intelligence? ". Before we dive in, let's first understand "What is Intelligence?" As humans, we think and act. This involves understanding our environment, predicting outcomes, and behaving accordingly. Similarly, AI focuses on building machines that can understand, predict, and act/respond effectively and safely. AI isn't exclusive to any specific industry. Its applications spread across different industries, including playing chess, proving mathematical theorems, driving cars, writing poetry, composing music, generating videos, diagnosing diseases, and much more. The field is continually evolving. Initially, AI was often defined in relation to matching ' Human performance '. However, AI has surpassed human capabilities in several areas and ...
Read more