NCL Website header
NCL Home > Documentation > HLUs > API

NhlSetValues

The Fortran name of this function is NhlFSetValues.

This function is used to change 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 NhlSetValues(
		int		obj_id,
		int		rlist_id
		)

Fortran synopsis

      subroutine NhlFSetValues(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 what resources to modify and what values to modify them to.
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

This function is used to change the resource values of an object after it has been created. The NhlSetValues function uses the ResList specified by the rlist_id parameter to determine what resources the programmer wants to modify, and the values to modify them to. The rlist_id is allocated using the NhlRLCreate function.

The NhlGetValues function can be used to retrieve the current resource values of an object.


Return values

The NhlSetValues C function returns a value of type NhlErrorTypes, and the NhlFSetValues Fortran subroutine returns the error in ierr. The following table indicates what the return error values mean:
Value	|			Meaning
--------+-------------------------------------------------
NOERROR	|	Object was modified with no problems.
--------+-------------------------------------------------
INFO	|	Error was recoverable - usually indicates
	|	that the programmer passed an invalid
	|	resource name or value.
--------+-------------------------------------------------
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	|	An error occurred such that the object
	|	being modified had to be destroyed to
	|	maintain the integrity of the HLU library.

See also