NCL Website header
NCL Home > Documentation > HLUs > API

NhlUpdateWorkstation

The Fortran name of this function is NhlFUpdateWorkstation.

This function updates the drawing area of an instance of a Workstation object.


C Synopsis

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

NhlErrorTypes NhlUpdateWorkstation(
	        int	workid
		)

Fortran Synopsis

     subroutine NhlFUpdateWorkstation(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 drawing area of the Workstation. For the XWorkstation object this function makes sure the X events queue is cleared which in turn causes all pending draw commands to be performed. For the NcgmWorkstation object this function causes all pending draw commands to be written to the metafile.

You can replace the usual call sequence of NhlUpdateWorkstation followed by NhlClearWorkstation with a single call to NhlFrame.


Return Values

The NhlUpdateWorkstation C function returns a value of type NhlErrorTypes, and the NhlFUpdateWorkstation 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