.\"
.\" $XConsortium: p072,v 5.2 94/04/17 20:55:06 rws Exp $
.\"
.\" 
$XMCOPY
.\" Copyright (c) 1990, 1991 by Sun Microsystems, Inc. and the X Consortium.
.\" 
.\"                         All Rights Reserved
.\" 
.\" Permission to use, copy, modify, and distribute this software and its 
.\" documentation for any purpose and without fee is hereby granted, 
.\" provided that the above copyright notice appear in all copies and that
.\" both that copyright notice and this permission notice appear in 
.\" supporting documentation, and that the names of Sun Microsystems,
.\" and the X Consortium not be used in advertising or publicity 
.\" pertaining to distribution of the software without specific, written 
.\" prior permission.  
.\" 
.\" SUN MICROSYSTEMS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, 
.\" INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
.\" EVENT SHALL SUN MICROSYSTEMS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
.\" CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
.\" USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
.\" OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.TH "GET VALUATOR" 3P "29 February 1991"
.SH NAME
GET VALUATOR \- retrieve the
\s-2VALUATOR\s+2
event in the \s-2PHIGS\s+2 current event report
.IX "Event Input Mode" "GET VALUATOR"
.IX "Input Modes" "GET VALUATOR"
.IX "Valuator Input Devices" "GET VALUATOR"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pget_val ( valuator )
Pfloat	*valuator;	\fI\s-2OUT\s+2 valuator value\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, WSOP, *, *)
.SH DESCRIPTION
.SS Purpose
\s-2GET VALUATOR\s+2 retrieves the current event report from the \s-2PHIGS\s+2
state list when the event report contains a \s-2VALUATOR\s+2 event.
.LP
A \s-2VALUATOR\s+2 event consists of a floating point number that the
operator has selected.
.SS C Output Parameter
.IP \fIvaluator\fP
\s-2PHIGS\s+2 copies the event's contents to the variable pointed to by
\fIvaluator\fP.
.SS Execution
\s-2GET VALUATOR\s+2 retrieves the contents of a \s-2VALUATOR\s+2
event from the current event report in the \s-2PHIGS\s+2 state list.
.LP
When an input device that is set to \s-2EVENT\s+2 mode is triggered
by the operator,
an event report is added to the input event queue.
The event report contains the identity and current measure of the triggered
device.
\s-2AWAIT EVENT\s+2 moves the measure of the oldest event in the input queue
to the current event report in the \s-2PHIGS\s+2 state list.
If the event was a \s-2VALUATOR\s+2 event, \s-2GET VALUATOR\s+2 is used to
retrieve the contents of the event from the current event report.
.LP
See \s-2INITIALIZE VALUATOR 3\s+2 for a description of the available
\s-2VALUATOR\s+2 devices and how their measure values are determined.
.SH ERRORS
.IP 003
Ignoring function, function requires state (\s-2PHOP, WSOP, *, *\s+2)
.IP 259
Ignoring function, the input device class of the current input report
does not match the class being requested
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "INITIALIZE VALUATOR (3P)"
.SM "INITIALIZE VALUATOR 3 (3P)"
.SM "AWAIT EVENT (3P)"
.fi
