NAG Library Function Document

nag_opt_handle_opt_set_file (e04zpc)

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}$ – void *Input

On entry: the handle to the problem. It needs to be initialized by nag_opt_handle_init (e04rac) and must not be changed.

2:    $\mathbf{fileid}$ – Nag_FileIDInput

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

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

The NAG error argument (see Section 2.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_HANDLE

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 nag_opt_handle_init (e04rac) or it has been corrupted.

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.

An unexpected error has been triggered by this function. Please contact NAG.
See Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.

NE_INVALID_FORMAT

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

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

NE_INVALID_OPTION

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

NE_INVALID_VALUE

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

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

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

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.

NE_NOT_READ_FILE

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.

NE_PHASE

The options cannot be modified in this phase.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example