NAG Library Routine Document

e04zpf  (handle_opt_set_file)

1

Purpose

2

Specification

3

Description

Begin * Example options file
   Print Level = 3 
   Monitoring Level = 5 * output all details
   Monitoring File = 42 * to this file
End

4

References

5

Arguments

1:     $\mathbf{handle}$ – Type (c_ptr)Input

On entry: the handle to the problem. It needs to be initialized by e04raf and must not be changed.

2:     $\mathbf{infile}$ – IntegerInput

On entry: the file identifier associated with the argument data file. Note:  that the file needs to be opened in read mode by x04acf with $\mathbf{mode}=0$.

Constraint: $\mathbf{infile}\ge 0$.

3:     $\mathbf{ifail}$ – IntegerInput/Output

On entry: ifail must be set to $0$, $-1\text{ or }1$. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.

For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{ or }1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this argument, the recommended value is $0$. When the value $-\mathbf{1}\text{ 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).

6

Error Indicators and Warnings

$\mathbf{ifail}=1$

The supplied handle does not define a valid handle to the data structure for the NAG optimization modelling suite. It has not been initialized by e04raf or it has been corrupted.

$\mathbf{ifail}=2$

The options cannot be modified in this phase.

$\mathbf{ifail}=3$

On entry, $\mathbf{infile}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{infile}\ge 0$.

$\mathbf{ifail}=4$

BEGIN found, but end-of-file found before END. All optional parameters that were set from the file before this error was encountered will remain set on exit.

End-of-file or read error detected before BEGIN was found.

$\mathbf{ifail}=11$

The option provided on line $〈\mathit{\text{value}}〉$ was not recognized.

$\mathbf{ifail}=12$

The expected delimiter ‘$=$’ was not found on line $〈\mathit{\text{value}}〉$.

$\mathbf{ifail}=13$

The optval provided on line $〈\mathit{\text{value}}〉$ could not be converted to the expected numerical type.

$\mathbf{ifail}=15$

The optval provided on line $〈\mathit{\text{value}}〉$ for the integer optional parameter is out of bounds.

$\mathbf{ifail}=16$

The optval provided on line $〈\mathit{\text{value}}〉$ for the real optional parameter is out of bounds.

$\mathbf{ifail}=17$

The optval provided on line $〈\mathit{\text{value}}〉$ for the character optional parameter is not valid.

$\mathbf{ifail}=-99$

An unexpected error has been triggered by this routine. Please contact NAG.

See Section 3.9 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{ifail}=-399$

Your licence key may have expired or may not have been installed correctly.

See Section 3.8 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{ifail}=-999$

Dynamic memory allocation failed.

See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example