NhlFreeColor
The Fortran name of this function is NhlFFreeColor.
This function removes a color, specified by its HLU index, from the
Workstation color map.
C Synopsis
#include <ncarg/hlu/hlu.h>
#include <hfile for Workstation class object>
NhlErrorTypes NhlFreeColor(
int workid,
int ci
)
Fortran Synopsis
subroutine NhlFFreeColor(workid, ci, ierr)
integer workid, ci, ierr
Arguments
- workid (input)
- Integer identifier of an instance of a
Workstation class object
- ci (input)
- Integer color index in the range 1 through 255 of a currently
allocated color.
- 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 deallocates a HLU color index from the
Workstation object's colormap. An error will be
generated if the color index is not currently allocated. Once a color
index has been freed, it will be eligible for reallocation during a
subsequent call to NhlNewColor. If you draw a plot
object using a freed color index to specify the color of any of its
features, those features will be drawn using the foreground color (HLU
color index 1, NhlFOREGROUND).
Return Values
The NhlFreeColor C function returns a value of type
NhlErrorTypes, and the NhlFFreeColor
Fortran subroutine returns the error in ierr. The following table
indicates what the various return Error Values mean:
Value | Meaning
--------+-------------------------------------------------
NOERROR | function successful
--------+-------------------------------------------------
INFO | minor recoverable error
--------+-------------------------------------------------
WARNING | recoverable error
--------+-------------------------------------------------
FATAL | function failed; continuing the program
| may result in core dump
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.10 $ $Date: 1998/06/15 21:26:11 $