NhlDestroy

The Fortran name of this function is NhlFDestroy.

This function is used to destroy an HLU object.

C synopsis

#include <ncarg/hlu/hlu.h>

NhlErrorTypes NhlDestroy(
		int		obj_id
		)

Fortran synopsis

      subroutine NhlFDestroy(obj_id, ierr)
      integer obj_id, ierr

Arguments

obj_id (input)
Identifies the HLU object to destroy. Returned from the NhlCreate function.
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 is used to free all the memory associated with the HLU object specified by the obj_id argument. It is important to note that the NhlDestroy function is a recursive function that destroys all the children objects of the object being destroyed. Therefore, if you call NhlDestroy on a Workstation class object that has children, those children objects will also be destroyed.

Return values

The NhlDestroy C function returns a value of type NhlErrorTypes, and the NhlFDestroy Fortran subroutine returns the error in ierr. The following table indicates what the return error values mean: 
Value	|			Meaning
--------+-------------------------------------------------
NOERROR	|	Object was destroyed with no errors.
--------+-------------------------------------------------
INFO	|	Object was destroyed and there was some
	|	recoverable error.
--------+-------------------------------------------------
WARNING	|	Object was destroyed and there was some
	|	unrecoverable error.
--------+-------------------------------------------------
FATAL	|	Unable to destroy object. Invalid obj_id.
NOTE: Since this is a recursive function, these error codes may actually be for a child of the specified object.

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