Progress
Language Reference


{ } Argument Reference

Interfaces
OS
SpeedScript
All
All
Yes

References the value of an argument that a procedure passes to a called external procedure file or to an include file.

Progress converts each argument to a character format. This conversion removes the surrounding double-quotes if the parameter was specified as a character string constant in the RUN statement or include file reference.

When one procedure is called from another and arguments are used, Progress recompiles the called procedure, substituting the arguments that the calling procedure passes, and then runs the called procedure.

SYNTAX

{ { n | &argument-name } } 

Enter the braces ({}) as shown; they do not represent syntax notation in this description.

n

The number of the argument being referred to. If n = 0, Progress substitutes the name of the current procedure (the name you used when you called it, not the full pathname) as the argument. If n = *, Progress substitutes all arguments that the calling procedure passes (but not the name {0}). If you refer to the nth parameter and the calling procedure does not supply it, {n} is ignored.

&argument-name

The name of the argument being referred to. If you refer to an argument-name and the calling procedure does not supply it, Progress ignores {&argument-name}.

If argument-name is an asterisk (*), Progress substitutes all arguments that the calling procedure passes. It also adds quotation marks to each parameter, so you can pass the named argument list through multiple levels of include files.

NOTE: It is invalid to pass both numbered and named arguments within a single pair of braces. Although this will not cause a compile-time or run-time error, the arguments will not be passed correctly.

EXAMPLES

The procedure r-arg.p runs procedure r-arg2.p, passing the arguments customer and name to r-arg2.p. Progress substitutes these arguments for {1} and {2} in the r-arg2.p procedure.

r-arg.p
RUN r-arg2.p "customer" "name" 

r-arg2.p
FOR EACH {1}:
  DISPLAY {2}.
END. 

The r-inc.p procedure defines the variables txt and num, and assigns the values Progress VERSION and 7 to them. The r-inc.p procedure includes the r-inc.ifile and passes the &int and &str arguments to the include file. Because the parameters are named, their order is unimportant. The called procedure can find each argument, regardless of placement. The r-inc.i include file displays a message that consists of the passed arguments. The asterisk argument displays all the parameters as they are listed in the r-inc.p procedure.

r-inc.p
DEFINE VARIABLE txt AS CHARACTER.
DEFINE VARIABLE num AS INTEGER.

txt = "Progress VERSION".
num = 7.

{r-inc.i &int=num &str=txt} 

r-inc.i
MESSAGE {&str}     /* the &str named argument */
        {&int}.    /* the &int named argument */

MESSAGE "An asterisk displays all the arguments:"
        {*}        /* all the arguments passed by the calling procedure */ 

NOTES

SEE ALSO

; Special Character, { } Include File Reference, { } Preprocessor Name Reference, COMPILE Statement, DEFINE PARAMETER Statement, RUN Statement


Copyright © 2004 Progress Software Corporation
www.progress.com
Voice: (781) 280-4000
Fax: (781) 280-4095