24
Tue, Dec
1 New Articles
  1. You are here:  
  2. Home
  3. Programming
  4. Programming - Other
  5. CL
  6. The Scan Variable (SCNVAR) Command

The Scan Variable (SCNVAR) Command

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

QCLSCAN is an IBM-supplied program that allows you to scan a string to see if it contains a particular pattern. The Scan Variable (SCNVAR) QUSRTOOL command provides a command interface to the QCLSCAN program. The SCNVAR command uses the same parameters as the QCLSCAN program, although not in the same order. The command interface is simpler to use in a CL program because you can prompt it while in SEU. It also supplies default values for several of the parameters which can reduce the number of parameters you must specify.

The RESULT parameter passed back to your program can be used to determine the result of the scan request. The SCNVAR command formats escape message CPF9898 based on the return code. You should monitor for that message and use either the message text or the return code value to determine the nature of the error.

To install the SCNVAR tool, use the CRTTAATOOL tool. If you haven't yet created CRTTAATOOL, information on how to create it can be found in source member CRTTAATOOL in file QUSRTOOL/QATTINFO.

Required Parameters

RESULT

Specify the variable name that is to contain the result of the scan. If the value specified in PATTERN is located in the value specified in STRING, this variable is set to indicate the position within STRING where the first occurrence of PATTERN was found. If PATTERN is not found in STRING, this variable is set to zero. The variable parameter must be defined as a *DEC field with a length of three and zero decimal positions. If any errors occur during the QCLSCAN program, the RESULT parameter will contain a negative number.

STRING

Specify the variable name that contains the character string to be scanned, or specify the character string. This parameter must be defined as a *CHAR field and can be up to 999 bytes long.

STRINGLEN

Specify the length of the argument given in parameter STRING. This parameter must be defined as a *DEC field with a length of three and zero decimal positions. Valid values range from 1 to 999.

Optional Parameters

STRPOS

Specify the variable name that contains the starting position within the string specified in STRING, or specify the starting position for the scan. This parameter must be defined as a *DEC field with a length of three and zero decimal positions.

1: The scan starts at the first position of the string specified in STRING.

starting-position: Specify the starting position for the scan. Valid values range from 1 to 999.

PATTERN

Specify the variable name that contains the pattern, or specify the character string to be scanned for. This parameter must be defined as a *CHAR field and can be up to 999 bytes long.

PATTERLEN

Specify the length of the pattern specified in PATTERN. This parameter must be defined as a *DEC field with a length of three and zero decimal positions. Valid values range from 1 to 999.

Even though this parameter is optional, you need to specify a value. If you don't, the command will assume you mean zero and return an error because zero isn't a valid length value.

TRANSLATE

Specify whether the value specified in STRING is to be translated to all uppercase before the scan is performed.

*NO: The value is not translated.

*YES: The value is translated into uppercase. Only the letters "a" through "z" are translated.

TRIM

Specify whether trailing blanks are to be trimmed from the variable specified in PATTERN before the scan is performed.

*NO: Trailing blanks are not trimmed.

*YES: Trailing blanks are trimmed.

WILD

Specify a single character that is to be used as a wild card when performing the scan. This parameter is used according to the rules for the QCLSCAN program.

Example

 SCNVAR RESULT(&RESULT) + STRING(&SRCSTRING) + STRINGLEN(80) STRPOS(7) + PATTERN('CHAIN') PATTERNLEN(5)

This command scans the source string contained within the variable &SRCSTRING for the pattern "CHAIN." The scan starts at position seven and scans for five characters. If the pattern is found in &SRCSTRING, the value of &RESULT is set to the starting position of the pattern; otherwise, &RESULT is set to zero unless an error is encountered.

Source Members

 INFO: SCNVAR (QATTINFO) CDO: TAACLPG (QATTCMD) CPP: TAACLPGC (QATTCL)

The foregoing article was adapted from Midrange Computing's QUSRTOOL Command Reference. The manual contains explanations and syntax diagrams for more than 300 obscure yet useful tools.

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: