NhlRLSetArray

NhlRLSetArray, NhlRLSetIntegerArray, NhlRLSetFloatArray, NhlRLSetDoubleArray, NhlRLSetStringArray

The Fortran names of these functions are NhlFRLSetIntegerArray, NhlFRLSetFloatArray, NhlFRLSetDoubleArray, NhlFRLSetStringArray. There is no Fortran binding for NhlRLSetArray.

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

C synopsis

#include <ncarg/hlu/hlu.h>

NhlErrorTypes NhlRLSetArray(
		int		list_id,
		NhlString	resname,
		NhlPointer	data,
		NhlString	type_element,
		unsigned int	size_element,
		int		num_elements
		)

NhlErrorTypes NhlRLSetIntegerArray(
		int		list_id,
		NhlString	resname,
		int		*data,
		int		num_elements
		)

NhlErrorTypes NhlRLSetFloatArray(
		int		list_id,
		NhlString	resname,
		float		*data,
		int		num_elements
		)

NhlErrorTypes NhlRLSetDoubleArray(
		int		list_id,
		NhlString	resname,
		double		*data,
		int		num_elements
		)

NhlErrorTypes NhlRLSetStringArray(
		int		list_id,
		NhlString	resname,
		NhlString	*data,
		int		num_elements
		)

Fortran synopsis

      subroutine NhlFRLSetIntegerArray(list_id, resname, iarray, 
     +                                 num_elements, ierr)
      integer list_id, iarray(num_elements), num_elements, ierr
      character*(*) resname

      subroutine NhlFRLSetFloatArray(list_id, resname, rarray,
     +                               num_elements, ierr)
      integer list_id, num_elements, ierr
      real rarray(num_elements)
      character*(*) resname

      subroutine NhlFRLSetDoubleArray(list_id, resname, darray,
     +                               num_elements, ierr)
      integer list_id, num_elements, ierr
      double precision darray(num_elements)
      character*(*) resname

      subroutine NhlFRLSetStringArray(list_id, resname, sarray,
     +                                num_elements, ierr)
      integer list_id, num_elements, ierr
      character*(*) resname, sarray(num_elements)

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 data to when the list is applied to an HLU object.
data (input, C only): Specifies the array value that will be applied to the corresponding resname when the list is applied to an HLU object.
type_elements (input, C only): Specifies the type of each element of the data array.
size_elements (input, C only): Specifies the size in bytes of each element of the data array.
num_elements (input): Specifies the number of elements in the data array.
iarray (input, Fortran only): Specifies the integer array that will be applied to the corresponding resname resource when the list is applied to an HLU object.
rarray (input, Fortran only): Specifies the real array that will be applied to the corresponding resname resource when the list is applied to an HLU object.
darray (input, Fortran only): Specifies the double precision array that will be applied to the corresponding resname resource when the list is applied to an HLU object.
sarray (input, Fortran only): Specifies the string array 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. These functions need to be used when the value part of the name/value pair is an Array.

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.

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.14 $ $Date: 1998/06/15 21:26:28 $