NhlRLGet

NhlRLGet, NhlRLGetInteger, NhlRLGetFloat, NhlRLGetDouble, NhlRLGetString

The Fortran names of these functions are NhlFRLGetInteger, NhlFRLGetFloat, NhlFRLGetDouble, NhlFRLGetString. There is no Fortran binding for NhlRLGet.

Used to retrieve the value of the given name in the ResList.

C synopsis

#include <ncarg/hlu/hlu.h>

NhlErrorTypes NhlRLGet(
		int		list_id,
		NhlString	resname,
		NhlString	type,
		<AnyType>	*val_addr
		)

NhlErrorTypes NhlRLGetInteger(
		int		list_id,
		NhlString	resname,
		int		*val_addr
		)

NhlErrorTypes NhlRLGetFloat(
		int		list_id,
		NhlString	resname,
		float		*val_addr
		)

NhlErrorTypes NhlRLGetDouble(
		int		list_id,
		NhlString	resname,
		double		*val_addr
		)

NhlErrorTypes NhlRLGetString(
		int		list_id,
		NhlString	resname,
		NhlString	*val_addr
		)

Fortran synopsis

      subroutine NhlFRLGetInteger(list_id, resname, ival, ierr)
      integer list_id, ival, ierr
      character*(*) resname

      subroutine NhlFRLGetFloat(list_id, rename, rval, ierr)
      integer list_id, ierr
      character*(*) resname
      real rval

      subroutine NhlFRLGetDouble(list_id, rename, dval, ierr)
      integer list_id, ierr
      character*(*) resname
      double precision dval

      subroutine NhlFRLGetString(list_id, resname, sval, ierr)
      integer list_id, ierr
      character*(*) resname, sval

Arguments

list_id (input): Id of the ResList to retrieve the resname/val_addr pair from.
resname (input): Specifies the resource name to retrieve the value of.
type (input, C only): Specifies the type val_addr points to.
val_addr (output, C only): Specifies the address to place the value retrieved from the resname resource when the list is applied to an HLU object using the NhlGetValues function.
ival (output, Fortran only): The integer value retrieved from the resname resource when the list is applied to an HLU object using the NhlFGetValues function.
rval (output, Fortran only): The real value retrieved from the resname resource when the list is applied to an HLU object using the NhlFGetValues function.
dval (output, Fortran only): The double precision value retrieved from the resname resource when the list is applied to an HLU object using the NhlFGetValues function.
sval (output, Fortran only): The string retrieved from the resname resource when the list is applied to an HLU object using the NhlFGetValues function.
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

These functions can only be used on a NhlGETRL ResList. They are used to retrieve name/val_addr pairs from the ResList that will be passed to the NhlGetValues function.

Return values

The C functions return a value of type NhlErrorTypes, and the Fortran subroutines return the error value in ierr. If they are unable to retrieve the name/val_addr pair from the list, they will return NhlFATAL, otherwise they will return NhlNOERROR.