aboutsummaryrefslogtreecommitdiff
path: root/vo/votools/doc/dispname.hlp
blob: 9c6cb6f3fa9665732be688661db53a32f78c9b19 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
.help dispname Mar12 votools
.ih
NAME
dispname -- Get the currently displayed image name
.ih
USAGE
dispname frame

.ih
PARAMETERS
.ls frame
Frame number to query.
.le

.ih
DESCRIPTION

The \fIDISPNAME\fR task is used to get the name of the image displayed
in the frame number specified by the \fIframe\fR parameter.

.ih
EXAMPLES

1. Print the displayed image name to the STDOUT

.nf
  votools> display dev$pix 1
  votools> dispname 1 verbose+
  dev$pix
.fi

2. Get the name, but use it within as script as a parameter:

.nf
    int  frame_num = 1
    dispname (frame_num)
    printf ("The displayed image is '%s'\n", dispname.name)
.fi


.ih
SEE ALSO

.endhelp