.\"##
.\" $XConsortium: p271,v 5.3 94/04/17 20:57:34 hersh Exp $
.\"##
.\"## 
$XMCOPY
.\"## Copyright (c) 1990, 1991 by Sun Microsystems, Inc. 
.\"## 
.\"##                         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 name of Sun Microsystems,
.\"## 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 "SAMPLE CHOICE" 3P "29 February 1991"
.SH NAME
SAMPLE CHOICE \- sample the current measure of a choice device
.IX "Sample Input Mode" "SAMPLE CHOICE"
.IX "Input Modes" "SAMPLE CHOICE"
.IX "Choice Input Devices" "SAMPLE CHOICE"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
psample_choice ( ws, dev, choice_in_status, choice )
Pint	ws;	\fIworkstation identifier\fP
Pint	dev;	\fIchoice device number\fP
Pin_status	*choice_in_status;	\fIOUT choice input status\fP
Pint	*choice;	\fIOUT choice\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, WSOP, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2SAMPLE CHOICE\s+2 to sample the current measure of the specified
choice device without waiting for the device trigger to fire. The device
must be in \s-2SAMPLE\s+2 mode.
See \s-2SET CHOICE MODE\s+2 and \s-2INITIALIZE CHOICE\s+2 for more information.
.SS C Input Parameters
.IP \fIws\fP
Workstation identifier. An integer specifying the workstation with which
the specified choice device is associated.
.IP \fIdev\fP
The device number of the choice device to be sampled.
See the \fIAvailable Devices\fP section of \s-2INITIALIZE CHOICE\s+2
for a description of the available devices.
.SS C Output Parameter
.IP \fIchoice_in_status\fP
A pointer to a location to store the status of the sample.
Pin_status is defined in phigs.h as:
.sp .4
.ta .5i
.nf
typedef enum {
.sp .2
	PIN_STATUS_NONE,
	PIN_STATUS_OK,
	PIN_STATUS_NO_IN
.sp .2
} Pin_status;
.fi
.IP \fIchoice\fP
A pointer to a location to store the results of the choice.
.SS Execution
\s-2SAMPLE CHOICE\s+2 samples the specified choice device. The
device must be in \s-2SAMPLE\s+2 mode.
See \s-2SET CHOICE MODE\s+2 and \s-2INITIALIZE CHOICE\s+2 for more
information.
.LP
When a device is set to \s-2SAMPLE\s+2 mode, a measure process is created
for the device and the device is activated. When \s-2SAMPLE CHOICE\s+2 is
called, the current value of the measure process for the specified device
is retrieved without waiting for the device's trigger to fire.
.SH ERRORS
.IP 003
Ignoring function, function requires state (\s-2PHOP, WSOP, *, *\s+2)
.IP 054
Ignoring function, the specified workstation is not open
.IP 061
Ignoring function, specified workstation is neither of category \s-2INPUT\s+2
nor of category \s-2OUTIN\s+2
.IP 250
Ignoring function, the specified device is not available
on the specified workstation
.IP 252
Ignoring function, the function requires the input device to
be in \s-2SAMPLE\s+2 mode
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "SET CHOICE MODE (3P)"
.SM "INITIALIZE CHOICE 3 (3P)"
.SM "REQUEST CHOICE (3P)"
.SM "GET CHOICE (3P)"
.SM "INQUIRE CHOICE DEVICE STATE (3P)"
.fi
