NCL Website header
NCL Home > Documentation > HLUs > API

NhlIsWorkstation

The Fortran name of this function is NhlFIsWorkstation.

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


C Synopsis

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

NhlBoolean NhlIsWorkstation(
	        int	id,
		)

Fortran Synopsis

      subroutine NhlFIsWorkstation(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 Workstation class object.

Return values

The NhlIsWorkstation C function returns True if the id identifies a Workstation class object, and False otherwise; the NhlFIsWorkstation Fortran subroutine returns the status in istatus.