NhlFrame

The Fortran name of this function is NhlFFrame.

This function first updates and then clears the drawing area of an instance of a Workstation object.

C Synopsis

#include <ncarg/hlu/hlu.h>
#include <hfile for Workstation class object>

NhlErrorTypes NhlFrame(
	        int	workid
		)

Fortran Synopsis

      subroutine NhlFFrame(workid, ierr)
      integer workid, ierr

Arguments

workid (input)
Integer identifier of an instance of a Workstation class object
ierr (output, Fortran only)
Error code

Types

Type name:		NhlTErrorTypes
Definition:
typedef enum _NhlErrType{
	NhlFATAL	= -4,	/* "FATAL"	*/
	NhlWARNING	= -3,	/* "WARNING"	*/
	NhlINFO		= -2,	/* "INFO"	*/
	NhlNOERROR	= -1	/* "NOERROR"	*/
} NhlErrorTypes;

Description

After executing NhlDraw for one or more plot objects, use this function to update the the drawing area of the Workstation and clear its drawing area in preparation for a new plot. A call to NhlFrame is equivalent to a call to NhlUpdateWorkstation followed by a call to NhlClearWorkstation.

Return Values

The NhlFrame C function returns a value of type NhlErrorTypes, and the NhlFFrame Fortran subroutine returns the error in ierr. The following table indicates what the various return Error Values mean: 
Value	|			Meaning
--------+-------------------------------------------------
NOERROR	|	function successful
--------+-------------------------------------------------
INFO	|	minor recoverable error
--------+-------------------------------------------------
WARNING	|	recoverable error
--------+-------------------------------------------------
FATAL	|	function failed; continuing the program
	|       may result in core dump

See Also

Copyright

Copyright 1987-1999 University Corporation for Atmospheric Research
The use of this Software is governed by a License Agreement.
NCAR Graphics is a registered trademark of the University Corporation for Atmospheric Research.

Reference Manual Control Panel

NG4.1 Home, Index, Examples, Glossary, Feedback, Ref Contents, Ref WhereAmI?

$Revision: 1.10 $ $Date: 1998/06/15 21:26:10 $