NhlGetValues

The Fortran name of this function is NhlFGetValues.

This function is used to retrieve the resource values of an instance of any HLU object. It is provided as an access function to objects that are Base class.

C synopsis

#include <ncarg/hlu/hlu.h>

NhlErrorTypes NhlGetValues(
		int		obj_id,
		int		rlist_id
		)

Fortran synopsis

      subroutine NhlFGetValues(obj_id, rlist_id, ierr)
      integer obj_id, rlist_id, ierr

Arguments

obj_id (input)
Id that identifies the object. Returned from the NhlCreate function.
rlist_id (input)
Id of a ResList that specifies which resources to retrieve and where put the retrieved values.
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

The NhlGetValues function is used to retrieve the resource values of an object. The NhlGetValues function uses the ResList specified by the rlist_id parameter to determine which resources to retrieve and where to put the retrieved values. The rlist_id is allocated using the NhlRLCreate function. The resource name and value pointer combinations are placed in the ResList using the NhlRLGet, NhlRLGetArray, and NhlRLGetMDArray functions.

The NhlSetValues function can be used to set the resource values of an object.

Return values

The NhlGetValues C function returns a value of type NhlErrorTypes, and the NhlFGetValues Fortran subroutine returns the error in ierr. The following table indicates what the return error values mean: 
Value	|			Meaning
--------+-------------------------------------------------
NOERROR	|	Values were retrieved with no detectable
	|	errors.
--------+-------------------------------------------------
INFO	|	Error was recoverable - usually indicates
	|	that the programmer passed an invalid
	|	resource name or value in the args
	|	argument that was ignored.
--------+-------------------------------------------------
WARNING	|	Error was recoverable - usually indicates
	|	that there may be some parts of the object
	|	that are not configured properly, and that
	|	a FATAL error may occur at a later time.
--------+-------------------------------------------------
FATAL	|	The function was unable to retrieve any
	|	values from the object. Could mean the
	|	obj_id was invalid.

See also

Copyright

Copyright 1987-1999 University Corporation for Atmospheric Research
The use of this Software is governed by a License Agreement.
NCAR Graphics is a registered trademark of the University Corporation for Atmospheric Research.

Reference Manual Control Panel

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

$Revision: 1.16 $ $Date: 1998/06/15 21:26:13 $