FindOptionValue()
Summary
Finds the value of an option in an options array.
Syntax
option = FindOptionValue (array options, string option_name)
| Argument | Contents |
|---|---|
| options | A list of options and their settings |
| option_name | The name of the option being sought in the options list |
Returns
An array that contains the values for the specified option.
Notes
-
If the named option does not appear in the list, FindOptionValue() returns null.
-
Comparison is always case insensitive and only up to the length of the option_name string.
Example
// Here's a typical option array...
opts = { {"Color", ColorRGB(0,0,0)},
{"Line Width", 4.5},
{"Names", "Fred", "Sam"}
}
// To locate a particular option:
opt = FindOptionValue(opts, "Line Width")
// opt is now equal to {4.5}
opt = FindOptionValue(opts, "Names")
// opt is now equal to {"Fred", "Sam"}See Also
| Function | Summary |
|---|---|
| FindOption() | Finds an option and its setting in an array of name-value pairs |