NhlRLGet

NhlRLGet, NhlRLGetInteger, NhlRLGetFloat, NhlRLGetString

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

Used to add the given name and val_addr to 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 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 NhlFRLGetString(list_id, resname, sval, ierr)
      integer list_id, ierr
      character*(*) resname, sval

Arguments

list_id: Id of the ResList to retrieve the resname/val_addr pair from.
resname: Specifies the resource name to retrieve the value of.
type (C only): Specifies the type val_addr points to.
val_addr (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 (Fortran only): The integer value retrieved from the resname resource when the list is applied to an HLU object using the NhlFGetValues function.
rval (Fortran only): The real value retrieved from the resname resource when the list is applied to an HLU object using the NhlFGetValues function.
sval (Fortran only): The string retrieved from the resname resource when the list is applied to an HLU object using the NhlFGetValues function.
ierr (Fortran only): Error code.

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

Copyright

Reference Manual Control Panel

NG4 Home, Index, Examples, Glossary, Feedback, Ref Contents, Ref WhereAmI?

$Revision: 1.10 $ $Date: 1995/07/26 23:28:24 $