1GESC(3NCARG)                     NCAR GRAPHICS                    GESC(3NCARG)
2
3
4

NAME

6       GESC (Escape) - provides a standard way of implementing nonstandard GKS
7       features.  NCAR GKS  has  only  two  user-accessible  escape  functions
8       defined:  one for changing the name of a metafile and another for paus‐
9       ing in an X window.
10

SYNOPSIS

12       CALL GESC (FCTID, LIDR, IDR, MXODR, LODR, ODR)
13

C-BINDING SYNOPSIS

15       #include <ncarg/gks.h>
16
17       void  gescape(Gint  func_id,  const  Gescape_in_data  *in_data,  Gstore
18       *store_data,Gescape_out_data **out_data);
19

DESCRIPTION

21       FCTID       (Integer,  Input)  -  A  function identifier specifying the
22                   requested activity.  The legal values for FCTID are "-1391"
23                   for  changing  a  metafile name and "-1396" for effecting a
24                   pause in an X window.
25
26       LIDR        (Integer, Input) - Dimension of the IDR input  data  record
27                   array (for IDR, see below).
28
29       IDR         (Character  *  80  Array,  Input) - Input data record.  For
30                   calls to GESC with FCTID equal  to  -1391  the  input  data
31                   record should contain the desired metafile name left justi‐
32                   fied and blank filled; for calls to GESC with  FCTID  equal
33                   to  -1396 the input data record should contain the worksta‐
34                   tion identifier encoded as a five character number.
35
36       MXODR       (Integer, Input) - Maximum length of the  ODR  output  data
37                   record array (for ODR, see below).
38
39       LODR        (Integer, Output) - Dimension of the ODR output data record
40                   array.
41
42       ODR (MXODR) (Character * 80 Array, Output) -  Output data record.
43

USAGE

45       LIDR, MXODR, and LODR must always be at least "1" in value.
46

EXAMPLES

48       GESC can be used to dynamically change the name of an  output  metafile
49       and  to  do  so  one  should  use  the calls GOPKS and GOPWK instead of
50       OPNGKS.  If you are using OPNGKS, see  the  man  page  for  SETUSV  for
51       changing the name of the metafile.
52
53       To  change  the  name  of  the output metafile inside your program, you
54       should make a call similar to the following:
55
56              CHARACTER*80 MFNAME
57
58              CALL GOPKS (6,IDUM)
59              MFNAME = 'new.cgm.name'
60              CALL GESC(-1391,1,MFNAME,1,1,CDUM)
61
62       The call to GESC to change the metafile name  must  always  occur  just
63       before  the  call  to  GOPWK that opens a CGM workstation.  Setting the
64       environment variable NCARG_GKS_OUTPUT overrides any attempt  to  change
65       the name of an output metafile via a GESC call.
66
67       See  the  "User's  Guide  for NCAR GKS-0A Graphics" for a more complete
68       example of changing metafile names from within a code.
69
70       Here is an example of a code that will create an X window, draw a line,
71       and then pause waiting for a mouse click or a key click.
72
73              CHARACTER*80 IREC,ODUM
74              CALL GOPKS(6,0)
75              CALL GOPWK(3,0,8)
76              CALL GACWK(3)
77              CALL LINE(0.,0.,1.,1.)
78              CALL SFLUSH
79              IREC = '    3'
80              CALL GESC(-1396,1,IREC,1,1,ODUM)
81              CALL GDAWK(3)
82              CALL GCLWK(3)
83              CALL GCLKS
84              STOP
85              END
86
87
88       The  functions  FRAME  and NGPICT are in general much easier to use and
89       more flexible than the direct ESCAPE call for pausing in an  X  window.
90       It is suggested that those functions be used.
91

ACCESS

93       To use GKS routines, load the NCAR GKS-0A library ncarg_gks.
94

SEE ALSO

96       Online: SETUSV, FRAME, NGPICT, gescape
97
98       Hardcopy:  User's  Guide for NCAR GKS-0A Graphics; NCAR Graphics Funda‐
99       mentals, UNIX Version
100
102       Copyright (C) 1987-2007
103       University Corporation for Atmospheric Research
104
105       This documentation is free software; you  can  redistribute  it  and/or
106       modify  it  under  the  terms of the GNU General Public License as pub‐
107       lished by the  Free  Software  Foundation;  either  version  2  of  the
108       License, or (at your option) any later version.
109
110       This  software  is  distributed in the hope that it will be useful, but
111       WITHOUT ANY  WARRANTY;  without  even  the  implied  warranty  of  MER‐
112       CHANTABILITY  or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
113       Public License for more details.
114
115       You should have received a copy of the GNU General Public License along
116       with  this  software;  if  not,  write to the Free Software Foundation,
117       Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
118
119
120
121UNIX                              March 1993                      GESC(3NCARG)
Impressum