.\"##
.\" $XConsortium: p226,v 5.3 94/04/17 20:57:03 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.
.ds f \s-2INQUIRE WORKSTATION CONNECTION AND TYPE\s+2
.TH "INQUIRE WORKSTATION CONNECTION AND TYPE" 3P "15 August 1991"
.SH NAME
INQUIRE WORKSTATION CONNECTION AND TYPE\- inquire a workstation's
connection identifier and type
.IX "Workstations" "INQUIRE WORKSTATION CONNECTION AND TYPE"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_ws_conn_type ( ws, store, error_ind, conn_id, ws_type )
Pint	ws;	\fIworkstation identifier\fP
Pstore  store;          \fI handle to Store object \fP 
Pint	*error_ind;	\fIOUT error indicator\fP
Pconnid *conn_id;	\fIOUT connection identifier\fP
Pint	*ws_type;	\fIOUT workstation type\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, WSOP, *, *)
.
.SH DESCRIPTION
.SS Purpose
Use \*f to inquire the specific workstation type and connection identifier
associated with a given workstation.  The connection identifier and
workstation type are associated with a workstation when it is opened.
At that time a \fIspecific workstation type\fP is created, based on the
generic type supplied by the caller, and the specific workstation type
and the user-supplied connection identifier are stored in the workstation's
state list.
This function returns that specific workstation type and the connection
identifier.
See \s-2OPEN WORKSTATION\s+2 for descriptions of the possible connection
identifiers and generic workstation types.
.SS C Input Parameters
.IP \fIws\fP
The workstation identifier of the workstation in question.
.IP \fIstring_length\fP
The size of the buffer (in bytes) pointed to by \fIconnid\fR for
the connection identifier to be returned in.
.SS C Output Parameters
.IP \fIerror_ind\fP
A pointer to the location to store the error number of any error detected by this function.
.IP \fIconn_id\fP
A pointer to a Pconnid (a pointer to the connection identifier).
.IP \fIws_type\fP
A pointer to a Pint variable in which to store the workstation type.
.
.SS Execution
\*f returns the specific workstation type and connection identifier
associated with the specified workstation.  See \s-2OPEN WORKSTATION\s+2
for a description of the possible connection identifiers and workstation
types.
.LP
Except in the case mentioned in the \s-2C\s+2 Parameters sections above,
if an error is detected by this function the \fIerror indicator\fP will
indicate the error number of the error detected and no other output data
will be returned.  If no error is detected, the \fIerror indicator\fP will
be set to zero and the inquired information will be available in the output
parameters.  Since this is an inquiry function, \s-2ERROR HANDLING\s+2 is not
invoked when an error is detected by this function.
.
.SH ERRORS
.IP 003
Ignoring function, function requires state 
(\s-2PHOP\s+2, \s-2WSOP\s+2, \s-2*\s+2, \s-2*\s+2)
.IP 054
Ignoring function, the specified workstation is not open
.IP 2200
Buffer overflow in input or inquiry function
.
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "PHIGS WORKSTATION DESCRIPTION TABLE (7P)"
.SM "INQUIRE LIST OF AVAILABLE WORKSTATION TYPES (3P)"
.SM "OPEN WORKSTATION (3P)"
.SM "WORKSTATION TYPE CREATE (3P)"
.SM "WORKSTATION TYPE GET (3P)"
.SM "WORKSTATION TYPE SET (3P)"
.fi
