Next: macrowrite() Up: MacAnova Help File Previous: macros   Contents


macrousage(Macro1 [,Macro2, ...] [,silent:T]), Macro1, Macro2, ...,
  currently defined macros

Keywords: macros, general
macrousage(Macro) prints all comment lines (lines that start with "#")
in Macro().  It is an error if Macro is not the name of a macro.  These
usally describe the usage of the macro, but that may not always be the

macrousage(Macro, silent:T) does the same, except any warning messages
are suppressed.  silent:T does *not* suppress printing the usage

macrousage(macroNames [,silent:T]), where macroNames is a quoted string
or CHARACTER variable specifying one or more macro names, prints the
comment lines in each macro named.

macrousage(arg1, arg2, ... [, silent:T]), where each argument is either
a macro or a CHARACTER variable does the same for several macros.

macrousage() returns in invisible LOGICAL scalar whose value is True if
and only if at least on macro was found.

  Cmd> macrousage(colplot, rowplot)
  Cmd> macrousage(listbrief(macros:T, keep:T)) # usage for all macros
  Cmd> if (!macrousage(foo,silent:T)){print("foo not found")}

See also topics help(), macro(), 'macros'.

Gary Oehlert 2003-01-15