NCL Website header
NCL Home > Documentation > Graphics > Resources

Error (err) Resources

errBuffer
This resource determines if error messages should be buffered so they can be extracted by the application programmer at a later time.

Default: False

errFileName
Specifies the file to print error messages to. The error object understands the file names "stderr" and "stdout" to be the streams associated with those standard FILE pointers in the UNIX environment. If the Error object is in Fortran mode, it will still interpret the "stderr" and "stdout" file names. If the errUnitNumber resource is not set, then the library will use the appropriate unit numbers for these standard UNIX streams. The error object will try to create a file of any other name relative to the current directory or append to that file if it already exists.

Default: "stderr"
Note: If the Error object is in C mode, and the errFilePtr resource is set, then this resource is ignored. Also, if the Error object is in Fortran mode, and the errUnitNumber is set to an Open unit, this resource is ignored.

errFilePtr
This resource is only used if the HLU library is initialized with one of the C functions NhlInitialize or NhlOpen. This resource specifies the C file pointer to print the error messages to, if the errPrint resource is True. If this resource is set, then the errFileName resource is ignored.

Default: NULL

errLevel
Specifies the error level that should be reported. Any error message that is less severe than this level will not be reported or buffered.

Default: WARNING

errPrint
Used to determine if error messages should be printed or not. If they are, they are printed to the file indicated by the errFileName, errFilePtr and errUnitNumber resources.

Default: True

errUnitNumber
This resource is only used if the HLU library is initialized with one of the Fortran routines NHLFINITIALIZE or NHLFOPEN. This resource specifies the Fortran unit number to print the error messages to if the errPrint resource is True. If the unit number has already been opened, then the Error object ignores the errFileName resource. If the unit number has not been opened yet, then the Error object attempts to open the file. If the errFileName resource has been set, then it uses that name, otherwise it doesn't. If this resource is not set, then the Error object just uses the errFileName resource to determine where it should print error messages.

Default: 74
Note: If the errFileName resource is set to either "stdout" or "stderr", then this defaults to the appropriate unit numbers for those standard UNIX streams, usually 6 and 0 respectively.