# NAG FL Interfacee05jjf (bnd_​mcs_​optget_​char)

## ▸▿ Contents

Settings help

FL Name Style:

FL Specification Language:

## 1Purpose

e05jjf is used to get the value of an ‘ON’/‘OFF’-valued character e05jbf optional parameter. e05jjf can be used before or after calling e05jbf, but the initialization routine e05jaf must have been called before calling e05jjf.

## 2Specification

Fortran Interface
 Subroutine e05jjf ( comm,
 Integer, Intent (In) :: lcomm Integer, Intent (Inout) :: ifail Real (Kind=nag_wp), Intent (In) :: comm(lcomm) Character (*), Intent (In) :: optstr Character (*), Intent (Out) :: cvalue
#include <nag.h>
 void e05jjf_ (const char *optstr, char *cvalue, const double comm[], const Integer *lcomm, Integer *ifail, const Charlen length_optstr, const Charlen length_cvalue)
The routine may be called by the names e05jjf or nagf_glopt_bnd_mcs_optget_char.

## 3Description

e05jjf obtains the current value of an ‘ON’/‘OFF’-valued character optional parameter. For example
`Call e05jjf ('Local Searches', lcsrch, comm, lcomm, ifail)`
will result in the ‘ON’/‘OFF’ value of the optional parameter Local Searches being output in LCSRCH.
A complete list of optional parameters, their symbolic names and default values is given in Section 12 in e05jbf.

None.

## 5Arguments

1: $\mathbf{optstr}$Character(*) Input
On entry: a string defining a single ‘ON’/‘OFF’-valued character optional parameter (as described in Section 12 in e05jbf).
2: $\mathbf{cvalue}$Character(*) Output
On exit: if ${\mathbf{ifail}}={\mathbf{0}}$ on exit, cvalue contains the ‘ON’/‘OFF’ value associated with the keyword in optstr.
3: $\mathbf{comm}\left({\mathbf{lcomm}}\right)$Real (Kind=nag_wp) array Communication Array
On entry: communication data as initialized by e05jaf.
4: $\mathbf{lcomm}$Integer Input
On entry: the dimension of the array comm as declared in the (sub)program from which e05jjf is called.
Constraint: ${\mathbf{lcomm}}\ge 100$.
5: $\mathbf{ifail}$Integer Input/Output
On entry: ifail must be set to $0$, $-1$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $-1$ means that an error message is printed while a value of $1$ means that it is not.
If halting is not appropriate, the value $-1$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $-\mathbf{1}$ or $\mathbf{1}$ is used it is essential to test the value of ifail on exit.
On exit: ${\mathbf{ifail}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).

## 6Error Indicators and Warnings

If on entry ${\mathbf{ifail}}=0$ or $-1$, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
${\mathbf{ifail}}=1$
Initialization routine e05jaf has not been called.
On entry, ${\mathbf{lcomm}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{lcomm}}\ge 100$.
${\mathbf{ifail}}=2$
The supplied optional parameter is invalid. A keyword or keyword combination was not recognized.
${\mathbf{ifail}}=-99$
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-399$
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

Not applicable.

## 8Parallelism and Performance

e05jjf is not threaded in any implementation.