.\"
.\" $XConsortium: p020,v 5.2 94/04/17 20:54:25 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 "CLOSE WORKSTATION" 3P "29 February 1991"
.SH NAME
CLOSE WORKSTATION \-  close a workstation
.IX "Workstations" "CLOSE WORKSTATION"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pclose_ws ( ws_id )
Pint	ws_id;	\fIworkstation identifier\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, WSOP, *, *)
.SH DESCRIPTION
.SS Purpose
\s-2CLOSE WORKSTATION\s+2 closes the specified workstation
and releases all resources it uses.
.SS C Input Parameter
.IP \fIws_id\fP
The identifier of the workstation to close.
.SS Execution
\s-2CLOSE WORKSTATION\s+2 performs the following functions:
.sp 
.in .7i
.ta .5i
.ti -.2i
\(bu    An implicit \s-2UPDATE WORKSTATION\s+2 is performed on the specified
workstation, with the regeneration flag set to \s-2PERFORM\s+2
.sp .2
.ti -.2i
\(bu    The workstation state list is released
.sp .2
.ti -.2i
\(bu    The workstation identifier is deleted from the set
of open workstations in the \s-2PHIGS\s+2 state list
.sp .2
.ti -.2i
\(bu    The workstation identifier is deleted from the list
of workstations to which structures are posted in the structure state list
.sp .2
.ti -.2i
\(bu    Any events in the input queue from devices on this
workstation are removed from the queue
.sp .2
.ti -.2i
\(bu    The specific workstation description table for this workstation,
created when the workstation was opened,
becomes unavailable and the workstation type value associated with
it becomes undefined
.sp .2
.ti -.2i
\(bu    The connection to this workstation is released
.sp .2
.ti -.2i
\(bu    If no other workstations are open, the \s-2PHIGS\s+2 workstation
operating state is set to \s-2WSCL\s+2
.DT
.sp
.LP
If an input queue overflow has been caused by a logical
input device associated the workstation being closed, the error state
list entry, identification of one of the logical input devices
that caused an input queue overflow, will become undefined when the
workstation is closed.
.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 256
Warning, the input queue has overflowed
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "INQUIRE SET OF OPEN WORKSTATIONS (3P)"
.SM "INQUIRE WORKSTATION STATE VALUE (3P)"
.SM "OPEN WORKSTATION (3P)"
.fi