.\"##
.\" $XConsortium: p131,v 5.2 94/04/17 20:55:56 rws 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 "INQUIRE EDIT MODE" 3P "29 February 1991"
.SH NAME
INQUIRE EDIT MODE \- inquire current edit mode for structure
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_edit_mode ( error_ind, edit_mode )
Pint	*error_ind;	\fI\s-2OUT\s+2 error indicator\fP
Pedit_mode	*edit_mode;	\fI\s-2OUT\s+2 edit mode\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE EDIT MODE\s+2 to determine the current edit mode for
structures.  The edit mode may be \s-2INSERT\s+2 or \s-2REPLACE\s+2.
.LP
See the description of the subroutine \s-2SET EDIT MODE\s+2
for information on the meaning of these modes.
.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 \fIedit_mode\fP
A pointer to a Pedit_mode enumerated type in which the system returns the
current structure edit mode.
Values for Pedit_mode are defined in phigs.h as follows:
.sp
.ta .5i
.nf
	PEDIT_INSERT
	PEDIT_REPLACE
.fi
.SH ERRORS
.IP 002
Ignoring function, function requires state (\s-2PHOP, *, *, *\s+2)
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "SET EDIT MODE (3P)"
.fi
