NhlClassName

The Fortran name of this function is NhlFClassName.

Returns the name of the class of an object.

C synopsis

#include <ncarg/hlu/hlu.h>

const char *NhlClassName(
		int	id
		)

Fortran synopsis

      subroutine NhlFClassName(id, name_ret, ierr)
      integer id, ierr
      character*(*) name_ret

Arguments

id (input)
Specifies the object identifier.
name_ret (output, Fortran only)
On output, the class name of the object specified by the id argument.
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

The C function returns the class name of the object specified by the id argument, and the Fortran subroutine returns the class name in the variable name_ret. This is the name of the class specified during the NhlCreate call that created the object.

Return values

The NhlClassName C function returns a valid const char* or NULL on error.

The NhlFClassName Fortran subroutine returns the error in ierr:

Value	|			Meaning
--------+-------------------------------------------------
NOERROR	|	Class name successfully copied to name_ret
--------+-------------------------------------------------
INFO	|	not possible
--------+-------------------------------------------------
WARNING	|	name_ret wasn't big enough
--------+-------------------------------------------------
FATAL	|	An invalid object id passed in.

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:04 $