Skip to main content

*OMIT vs *NOPASS: Understanding the Key Differences - IBM i

*OMIT v/s *NOPASS

In RPGLE, *OMIT and *NOPASS are the two options used to specify the optional parameters for the procedures. It is essential to understand the difference between *OMIT and *NOPASS because knowing which keyword to use for the specific case helps in writing the clean code. 

Before we jump on to the key differences, let's have a look at the use of each of the keywords.

*OMIT

By using the *OMIT on the parameter while declaring a procedure, we can make this parameter an optional parameter. 

We could either pass the data to this parameter or simply pass '*OMIT' to while calling the procedure. 

Dcl-PR SampleProcedure;                              

  MandatoryParameter1 Char(1);                       

  OptionalParameterWithOmit Char(1) Options(*Omit);  

  MandatoryParameter2 Packed(1);                     

End-PR;                                              

                                                     

Dcl-Proc SampleProcedure Export;                     

  Dcl-PI SampleProcedure;                            

    MandatoryParameter1 Char(1);                     

    OptionalParameterWithOmit Char(1) Options(*Omit);

    MandatoryParameter2 Packed(1);                   

  End-PI;                                            

                              

  // Code to be run in the procedure         

                                        

End-Proc;                               


This procedure can be called in one of the two ways,
  • Either by passing the data for the optional parameter. 
  • Or by passing '*OMIT' to avoid passing this parameter. 

// Passing the data

SampleProcedure('A' : 'B' : 1);                      


// Passing *Omit

SampleProcedure('A' : *Omit : 1);


*NOPASS

By using the *NOPASS on the parameter while declaring a procedure, we can make this parameter an optional parameter. 

We could either pass the data to this parameter or not pass this parameter at all while calling the procedure. 

Dcl-PR SampleProcedure;                                  

  MandatoryParameter1 Char(1);                           

  MandatoryParameter2 Packed(1);                         

  OptionalParameterWithNoPass Char(1) Options(*NoPass);  

End-PR;                                                  

                                                         

Dcl-Proc SampleProcedure Export;                         

  Dcl-PI SampleProcedure;                                

    MandatoryParameter1 Char(1);                         

    MandatoryParameter2 Packed(1);                       

    OptionalParameterWithNoPass Char(1) Options(*NoPass);

  End-PI;                                                

                                                         

  // Code to be run in the procedure;                  

                                                         

End-Proc;                                                


This procedure can be called in one of the two ways,
  • Either by passing the data for the optional parameter. 
  • Or by not passing the parameter at all.

// Passing the data

SampleProcedure('A' : 1 : 'B');                      


// Not passing the optional parameter

SampleProcedure('A' : 1);


The Difference

There are couple of main differences between using *OMIT and *NOPASS. 
  • *OMIT can be used on any parameter, whereas *NOPASS can only be used on the last parameter(s) i.e., no mandatory parameter can be declared after *NOPASS is specified. 
  • *OMIT needs to passed to avoid passing the parameter declared with *OMIT, whereas no parameter needs to be passed when specified using *NOPASS (considering it is the last parameter). 

I hope this post has help in understanding what is the use of *OMIT, *NOPASS and the difference. 


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

Comments

Post a Comment

Popular posts from this blog

All about READ in RPGLE & Why we use it with SETLL/SETGT?

READ READ is one of the most used Opcodes in RPGLE. As the name suggests main purpose of this Opcode is to read a record from Database file. What are the different READ Opcodes? To list, Below are the five Opcodes.  READ - Read a Record READC - Read Next Changed Record READE - Read Equal Key Record READP - Read Prior Record READPE - Read Prior Equal Record We will see more about each of these later in this article. Before that, We will see a bit about SETLL/SETGT .  SETLL (Set Lower Limit) SETLL accepts Key Fields or Relative Record Number (RRN) as Search Arguments and positions the file at the Corresponding Record (or Next Record if exact match isn't found).  SETGT (Set Greater Than) SETGT accepts Key Fields or Relative Record Number (RRN) as Search Arguments and positions the file at the Next Record (Greater Than the Key value). Syntax: SETLL SEARCH-ARGUMENTS/KEYFIELDS FILENAME SETGT  SEARCH-ARGUMENTS/KEYFIELDS FILENAME One of the below can be passed as Search Arguments. Key Fiel
4 comments
Read more

What we need to know about CHAIN (RPGLE) & How is it different from READ?

CHAIN READ & CHAIN, These are one of the most used (& useful) Opcodes by any RPG developer. These Opcodes are used to read a record from file. So, What's the difference between CHAIN & READ?   CHAIN operation retrieves a record based on the Key specified. It's more like Retrieving Random record from a Database file based on the Key fields.  READ operation reads the record currently pointed to from a Database file. There are multiple Opcodes that start with READ and all are used to read a record but with slight difference. We will see more about different Opcodes and How they are different from each other (and CHAIN) in another article. Few differences to note.  CHAIN requires Key fields to read a record where as READ would read the record currently pointed to (SETLL or SETGT are used to point a Record).  If there are multiple records with the same Key data, CHAIN would return the same record every time. READE can be used to read all the records with the specified Ke
Post a Comment
Read more

Extract a portion of a Date/Time/Timestamp in RPGLE - IBM i

%SUBDT Extracting Year, Month, Day, Hour, Minutes, Seconds or Milli seconds of a given Date/Time/Timestamp is required most of the times.  This can be extracted easily by using %SUBDT. BIF name looks more similar to %SUBST which is used to extract a portion of string by passing from and two positions of the original string. Instead, We would need to pass a value (i.e., Date, Time or Timestamp ) and Unit (i.e., *YEARS, *MONTHS, *DAYS, *HOURS, *MINUTES, *SECONDS or *MSECONDS) to %SUBDT.  Valid unit should be passed for the type of the value passed. Below are the valid values for each type. Date - *DAYS, *MONTHS, *YEARS Time - *HOURS, *MINUTES, *SECONDS Timestamp - *DAYS, *MONTHS, *YEARS, *HOURS, *MINUTES, *SECONDS, *MSECONDS Syntax: %SUBDT(value : unit { : digits { : decpos} }) Value and Unit are the mandatory arguments.  Digits and Decimal positions are optional and can only be used with *SECONDS for Timestamp. We can either pass the full form for the unit or use the short form. Below i
2 comments
Read more