NCL Website header
NCL Home > Documentation > HLUs > API

NhlCreate

The Fortran name of this function is NhlFCreate.

This function is used to create an instance of any HLU object. It is provided as an access function to objects that are Base class.


C synopsis

#include <ncarg/hlu/hlu.h>
#include <hfile for class being created>

NhlErrorTypes NhlCreate(
		int		*ret_id,
		NhlString	name,
		NhlClass	lc,
		int		parent_id,
		int		rlist_id
		)

Fortran synopsis

      external function_for_class_being_created
      subroutine NhlFCreate(ret_id, name, lc, parent_id, rlist_id, ierr)
      integer ret_id, parent_id, rlist_id, ierr
      character*(*) name
      external lc

Arguments

ret_id (output)
Returns the object id that is used to identify the created object. HLU object ids are always positive numbers. If this function is unable to create the object, this value will be set to the return value of the function (NhlFATAL).
name (input)
Sets the name of the object being created.
lc (input)
Identifies the class of object to create, i.e. the type of object to create.
parent_id (input)
Id of the object that should be the parent of the object being created. The constant NhlDEFAULT_APP (0) can be used to indicate the current default parent App object.
rlist_id (input)
Id of a ResList that specifies which resources to initialize, and what values to initialize them to. A value of 0 can be used to indicate a NULL ResList. The ResList should be created with a list_type of NhlSETRL (or 'setrl' in Fortran).
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;