NAG C Library Function Document

nag_blgm_optget (g22znc)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:    $\mathbf{handle}$ – void *Input

On entry: the G22 handle which must have been initialized by one of Chapter g22's initialization functions.

2:    $\mathbf{optstr}$ – const char *Input

On entry: a string identifying the option and, where required, the instance identifier.

identify

Returns a string description of the G22 handle supplied in handle. See Section 9 for more details.

option

Returns the value of option. If there are multiple instances of option, the value of the first is returned. If not all instances of option have the same value, $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NW_INSTANCE is returned.

$\mathit{option}:\mathit{instance\; identifier}$

Returns the value of a single instance of option.

optstr is case insensitive and option and instance identifier may consist of one or more tokens separated by white space.

See the documentation of the individual Chapter g22 functions for details of valid values for option and instance identifier.

3:    $\mathbf{ivalue}$ – Integer *Output

On exit: if $\mathbf{optype}=\mathrm{Nag\_Integer}$, option identifies an integer-valued optional parameter and ivalue holds its current value.

4:    $\mathbf{rvalue}$ – double *Output

On exit: if $\mathbf{optype}=\mathrm{Nag\_Real}$, option identifies a real-valued optional parameter and rvalue holds its current value.

5:    $\mathbf{cvalue}$ – char *Output

Note: the string returned in cvalue will never exceed $\min \left(\mathbf{lcvalue},41\right)$ characters in length, including the terminating null character.

On exit: if $\mathbf{optype}=\mathrm{Nag\_Character}$, option identifies a character-valued optional parameter and cvalue holds its current value.

6:    $\mathbf{lcvalue}$ – IntegerInput

On entry: length of the string cvalue. At most $\mathbf{lcvalue}-1$ non-null characters will be written into cvalue.

Constraint: $\mathbf{lcvalue}>1$.

7:    $\mathbf{optype}$ – Nag_VariableType *Output

On exit: indicates whether option is an integer, real or character-valued optional parameter and hence which of ivalue, rvalue or cvalue holds the current value.

$\mathbf{optype}=\mathrm{Nag\_Integer}$

option is an integer-valued optional parameter; its current value has been returned in ivalue.

$\mathbf{optype}=\mathrm{Nag\_Real}$

option is a real-valued optional parameter; its current value has been returned in rvalue.

$\mathbf{optype}=\mathrm{Nag\_Character}$

option is a character-valued optional parameter; its current value has been returned in cvalue.

8:    $\mathbf{fail}$ – NagError *Input/Output

The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

6

Error Indicators and Warnings

NE_ALLOC_FAIL

Dynamic memory allocation failed.
See Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.

NE_BAD_PARAM

On entry, argument $〈\mathit{\text{value}}〉$ had an illegal value.

NE_HANDLE

handle has not been initialized or is corrupt.

handle is not a G22 handle.

NE_INSTANCE

Invalid instance identifier for option.
On entry, $\mathbf{optstr}=〈\mathit{\text{value}}〉$.

Numeric instance identifier is out of range.
On entry, $\mathit{instance\; identifier}=〈\mathit{\text{value}}〉$.
Constraint: $〈\mathit{\text{value}}〉\le \mathit{instance\; identifier}$ and $\mathit{instance\; identifier}\le 〈\mathit{\text{value}}〉$.

NE_INT

On entry, $\mathbf{lcvalue}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{lcvalue}>1$.

NE_INTERNAL_ERROR

An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.

NE_INVALID_OPTION

On entry, option is not readable: $\mathbf{optstr}=〈\mathit{\text{value}}〉$.

On entry, option was not recognized: $\mathbf{optstr}=〈\mathit{\text{value}}〉$.

NE_NO_LICENCE

Your licence key may have expired or may not have been installed correctly.
See Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.

NW_INSTANCE

On entry, option cannot have an associated instance identifier. The supplied instance identifier was ignored.
$\mathbf{optstr}=〈\mathit{\text{value}}〉$.

option has multiple instances. Information from the first instance has been returned.

NW_TRUNCATED

On entry, option is a character optional parameter, but cvalue is too short to hold the stored value. The minimum number of characters to store the value is returned in ivalue. The value returned in cvalue will be truncated.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example