NCL Website header
NCL Home > Documentation > HLUs > API

NhlIsDataItem

The Fortran name of this function is NhlFIsDataItem.

This boolean function returns True if the given id identifies a DataItem class object, and False otherwise.


C Synopsis

#include </ncarg/hlu/DataItem.h>

NhlBoolean NhlIsDataItem(
	        int	id,
		)

Fortran Synopsis

      subroutine NhlFIsDataItem(id, istatus)
      integer id, istatus

Arguments

id (input)
Specifies an integer id to an existing HLU object.
istatus (output, Fortran only)
On output, the status of the object.

Description

You use this function to determine if the id you supply identifies a DataItem class object.

Return values

The NhlIsDataItem C function returns True if the id identifies a DataItem class object, and False otherwise; the NhlFIsDataItem Fortran subroutine returns the status in istatus.