NhlRLSet

NhlRLSet, NhlRLSetInteger, NhlRLSetFloat, NhlRLSetDouble, NhlRLSetString

The Fortran names of these functions are NhlFRLSetInteger, NhlFRLSetFloat, NhlFRLSetDouble, NhlFRLSetString. There is no Fortran binding for NhlRLSet.

Used to add the given name and value to the ResList.

C synopsis

#include <ncarg/hlu/hlu.h>

NhlErrorTypes NhlRLSet(
		int		list_id,
		NhlString	resname,
		NhlString	type,
		<AnyType>	value
		)

NhlErrorTypes NhlRLSetInteger(
		int		list_id,
		NhlString	resname,
		int		value
		)

NhlErrorTypes NhlRLSetFloat(
		int		list_id,
		NhlString	resname,
		float		value
		)

NhlErrorTypes NhlRLSetDouble(
		int		list_id,
		NhlString	resname,
		double		value
		)

NhlErrorTypes NhlRLSetString(
		int		list_id,
		NhlString	resname,
		NhlString	value
		)

Fortran synopsis

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

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

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

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

Arguments

list_id (input): Id of the ResList to add the name/value pair to.
resname (input): Specifies the resource name to apply the given value to when the list is applied to an HLU object.
type (input, C only): Specifies the type for value.
value (input, C only): Specifies the value that will be applied to the corresponding resname when the list is applied to an HLU object.
ival (input, Fortran only): Specifies the integer value that will be applied to the corresponding resname resource when the list is applied to an HLU object.
rval (input, Fortran only): Specifies the real value that will be applied to the corresponding resname resource when the list is applied to an HLU object.
dval (input, Fortran only): Specifies the double precision value that will be applied to the corresponding resname resource when the list is applied to an HLU object.
sval (input, Fortran only): Specifies the string that will be applied to the corresponding resname resource when the list is applied to an HLU object.
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 NhlSETRL ResList. They are used to add name/value pairs to the ResList that will be passed to the NhlCreate or NhlSetValues functions.

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 add the name/val_addr pair to the list, they will return NhlFATAL; otherwise they will return NhlNOERROR.