NCL Home > Documentation > HLUs > API

NhlIsDataComm

The Fortran name of this function is NhlFIsDataComm.

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


C Synopsis

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

NhlBoolean NhlIsDataComm(
	        int	id,
		)

Fortran Synopsis

      subroutine NhlFIsDataComm(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 DataComm class object.

Return values

The NhlIsDataComm C function returns True if the id identifies a DataComm class object, and False otherwise; the NhlFIsDataComm Fortran subroutine returns the status in istatus.