NhlRemoveAnnotation
The Fortran name of this function is NhlFRemoveAnnotation.
This function removes an arbitrary View object
annotation from a Plot Object, destroying its
AnnoManager object.
C Synopsis
#include <ncarg/hlu/hlu.h>
#include <hfile for Plot Object>
NhlErrorTypes NhlRemoveAnnotation(
int plot_id,
int anno_manager_id
)
Fortran Synopsis
subroutine NhlFRemoveAnnotation(plot_id, anno_manager_id, ierr)
integer plot_id, anno_manager_id, ierr
Arguments
- plot_id
- Identifier of the plot object from which
the View object annotation is to be removed.
- anno_manager_id
- Identifier of the AnnoManager for
the View object annotation to be removed.
- ierr (Fortran only)
- Error code.
Description
Use this function to remove a user-created external
annotation from a plot
object. Along with the plot object's id, you must supply the
identifier of the controlling AnnoManager object. If
you have only the view id, you can always
retrieve the AnnoManager's id by getting the value of
the View resource vpAnnoManagerId.
Assuming the object ids are valid, the plot object
destroys the AnnoManager object, and removes the ids
of the View object and the
AnnoManager from the array resources pmAnnoViews and pmAnnoManagers
This removes any further association between the View
object and the plot object. Note that you are responsible for
destroying the View object when you are finished with
it.
Return Values
The NhlRemoveAnnotation C function returns a value of
type NhlErrorTypes, and the
NhlFRemoveAnnotation Fortran subroutine returns the
error value in ierr. The following table indicates what the various
return Error Values mean:
Value | Meaning
--------+-------------------------------------------------
NOERROR | view succesfully removed from the plot object
--------+-------------------------------------------------
INFO | minor recoverable error
--------+-------------------------------------------------
WARNING | recoverable error
--------+-------------------------------------------------
FATAL | The function was unsuccessful
See Also
Copyright
Copyright 1987,1988,1989,1991,1993,1994,1995
University Corporation for Atmospheric Research
All Rights Reserved
Reference Manual Control Panel
NG4 Home, Index, Examples, Glossary, Feedback, Ref Contents, Ref WhereAmI?
$Revision: 1.11 $ $Date: 1995/07/26 23:28:37 $