Ekern at 02:52, 7 October 2022

2022-10-07T02:52:08Z

← Older revision		Revision as of 02:52, 7 October 2022
Line 16:		Line 16:
	==== Predefined macro variables ====		==== Predefined macro variables ====

	<span class="f_Para">The system </span><span class="f_Monospace">&argstring</span><span class="f_Para"> variable is described in [[~~passing_arguments_to_macros.html~~#~~using_argstring~~\|Passing a command argument to a macro.]] </span>		<span class="f_Para">The system </span><span class="f_Monospace">&argstring</span><span class="f_Para"> variable is described in [[Passing a command argument to a macro#Using the &argstring variable\|Passing a command argument to a macro.]] </span>

	==== User-defined macro variables ====		==== User-defined macro variables ====

Ekern: Created page with "TOC Macro variables are placeholders for Debugger command arguments within Debugger macros, as well as placeholders for Client function arguments. Dis..."

2022-10-07T02:44:33Z

Created page with "__TOC__ Macro variables are placeholders for Debugger command arguments within Debugger macros, as well as placeholders for Client function arguments. Dis..."

New page

__TOC__
Macro variables are placeholders for Debugger command arguments within Debugger macros, as well as placeholders for Client function arguments. Distinguished by names that begin with a single ampersand (&) character, macro variables can be set to a variety of types of values. 

As an example, you could have a macro set some breakpoints, run to each of them, and use a macro variable to note the value of the program's %variable at each break. This would let you note the values at different points in program execution: 

breaks 
run 
set &val1 = %i 
run 
set &val2 = %i 
echo &val1 
echo &val2 

Macro variables are either system-supplied (predefined) or user-defined. 

==== Predefined macro variables ====

The system &argstring variable is described in [[passing_arguments_to_macros.html#using_argstring|Passing a command argument to a macro.]] 

==== User-defined macro variables ====

To define a macro variable or change its value, you use the [[set command|set]] command. As shown below, the types of values to which you can set the variable include constants, User Language variables, fields, and $list elements, and other macro variables and functions. 

These command examples also show that multiple blanks may surround names and values:

 

SET &a2 = %a(2) 
 set &i=%i 
SET &g = %G 
set &s=%s 
set &l = %L 
set &lc = $listcnt(%g) 
set &l1 = $listinf(%g,1) 
set &l2 = $listinf(%g,2) 
set &global = g.JACK 
set &sl = %sl:item(1) 
set &num = 1 
set &string = "a" 
set &a = &&prompt("g'day mate!")
set &f = f.name 
set &f3 = f.name(3) 
set &a2 = -1 
set &xx = &asa 
 

If you want to review the values of macro variables you have defined, you can issue the [[varDump command|varDump]] command, for example from the [[Using the console and command line#The Command Line|Command Line]] tool. Other commands useful for working with macro variables include [[setM204Data command|setM204Data]], [[assert command|assert]], [[continueIf command|continueIf]], and [[toggle command|toggle]]. 

[[Category:Debugger Home]]

Working with macro variables - Revision history

Ekern at 02:52, 7 October 2022

Ekern: Created page with "__TOC__ Macro variables are placeholders for Debugger command arguments within Debugger macros, as well as placeholders for Client function arguments. Dis..."

Ekern: Created page with "TOC Macro variables are placeholders for Debugger command arguments within Debugger macros, as well as placeholders for Client function arguments. Dis..."