Next: getseeds()
Up: MacAnova Help File
Previous: getnotes()
Contents
Usage:
getoptions(option1:T [,option2:T ... ] [,badoptok:T]), option1, option2,
... option names.
getoptions() or getoptions(all:T) gets all option values as a structure
Type 'usage(options)' for a succinct list of all options and their
permissible values.
|
Keywords:
control
Usage
getoptions(option1:T, option2:T, ...), where option1, option2, ... are
option names, returns the values of the specified options. If more than
one option is specified, the result is a structure with appropriately
named components. For example, getoptions(format:T) returns the default
format used in printing, getoptions(seeds:T) is equivalent to
getseeds(quiet:T), and getoptions(height:T,width:T) returns a structure
with components 'height' and 'width'.
getoptions() or getoptions(all:T) returns the values for all options.
getoptions(all:T, option1:F, option2:F,...) returns values for all
options except those specified.
Legal option names
Legal option names are 'angles', 'batchecho', 'dumbplot', 'errors',
'findmacros', 'format', 'fstats', 'height', 'history', 'inline',
'labelabove', 'labelstyle', 'keyboard', 'maxlinelen', 'maxwhile',
'minpvalue', 'missing', 'nsig', 'pvals', 'prompt', 'restoredel',
'savehistry', 'seeds', 'traceback' 'update', 'warnings', 'wformat',
and 'width'.
See topic 'options' for details on these options. Type 'usage(options)'
for a list of options with legal values and defaults.
Option name 'lines' is recognized as a synonym for 'height' for
compatibility with earlier versions.
On windowed versions, option 'scrollback' is also legal.
In the Mac OS 9 version, options 'font' and 'fontsize' are
also legal.
Options 'format' and 'wformat'
The value returned for 'format' or 'wformat' always has the type
specifier ('f' or 'g') at the end ("12.5g"), even if it was set with a
string starting with 'f' or 'g' ("g12.5").
Keyword 'badoptok'
getoptions(option1:T[, option2:T, ...] ,badoptok:T) does the same,
except it is not an error if the options requested are legel. If no
legal options are specified, getoptions() returns NULL.
This feature is intended to allow macros using new options to be written
in such a way that they are backward compatible with MacAnova versions
without the new options.
Cross references
See also restore(), save().
Gary Oehlert
2006-01-30