NhlChangeWorkstation

The Fortran name of this function is NhlFChangeWorkstation.

This function is used to change the Workstation parent of any graphical HLU object. It is provided as an access function to objects that are Base class.

C synopsis

#include <ncarg/hlu/hlu.h>

NhlErrorTypes NhlChangeWorkstation(
		int		plot_id,
		int		work_id
		)

Fortran synopsis

      subroutine NhlFChangeWorkstation(plot_id, work_id, ierr)
      integer plot_id, work_id, ierr

Arguments

plot_id (input)
Id that identifies the graphical object to move to another Workstation class parent.
work_id (input)
Id that identifies the workstation object to move the graphical object 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 output device that the graphical object will be drawn to. It effectively Reparents the given plot_id so it behaves as if the given work_id was passed to the Create function as the parent_id. Although, since resource values are determined at NhlCreate time, the resource values of the plot_id object are not modified.

Return values

The NhlChangeWorkstation C function returns a value of type NhlErrorTypes, and the NhlFChangeWorkstation Fortran subroutine returns the error in ierr. The following table indicates what the return error values mean: 
Value	|			Meaning
--------+-------------------------------------------------
NOERROR	|	Object was reparented so it will draw to
	|	the new Workstation object with no errors.
--------+-------------------------------------------------
INFO	|	No errors of this type.
--------+-------------------------------------------------
WARNING	|	No errors of this type.
--------+-------------------------------------------------
FATAL	|	Object given was not reparented. Usually
	|	indicates that the plot_id was invalid, or
	|	the work_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.15 $ $Date: 1998/06/15 21:26:03 $