NhlClearWorkstation

The Fortran name of this function is NhlFClearWorkstation.

This function 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 NhlClearWorkstation(
	        int	workid
		)

Fortran Synopsis

       subroutine NhlFClearWorkstation(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

This function clears the Workstation drawing area. For XWorkstation objects NhlClearWorkstation clears the window associated with the XWorkstation object. If the XWorkstation resource wkPause is set True, the NhlClearWorkstation blocks until the user clicks a mouse button in the window. For NcgmWorkstation objects this function causes an End Picture command to be written to the output metafile and places the metafile generator into a state such that it is prepared either to begin a new metafile picture if new draw commands are received or to end the metafile if the workstation object is destroyed.

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

Return Values

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

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.12 $ $Date: 1998/06/15 21:26:05 $