• ← OptionQ
• → Options

OptionValue

WMA link

OptionValue[name]

gives the value of the option name as specified in a call to a function with OptionsPattern.

OptionValue[f, name]

recover the value of the option name associated to the symbol f.

OptionValue[f, optvals, name]

recover the value of the option name associated to the symbol f, extracting the values from optvals if available.

OptionValue[..., list]

recover the value of the options in list .

• • f[a->3] /. f[OptionsPattern[{}]] -> {OptionValue[a]}

Unavailable options generate a message:

• • f[a->3] /. f[OptionsPattern[{}]] -> {OptionValue[b]}

The argument of OptionValue must be a symbol:

• • f[a->3] /. f[OptionsPattern[{}]] -> {OptionValue[a+b]}

However, it can be evaluated dynamically:

• • f[a->5] /. f[OptionsPattern[{}]] -> {OptionValue[Symbol["a"]]}