.\"
.\" $XConsortium: p044,v 5.3 94/04/17 20:54:45 hersh 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.
.ds f \s-2ESCAPE -1\s+2
.ds e \s-2ESCAPE\s+2
.ds s \s-2PEX-SI\s+2
.ds pr \s-2PACK DATA RECORD\s+2
.ds ur \s-2UNPACK DATA RECORD\s+2
.ds eh \s-2ERROR HANDLING\s+2
.TH "ESCAPE -1" 3P "29 February 1991"
.SH NAME
ESCAPE -1 \- enforce synchronized error reporting
.IX "Errors" "ESCAPE -1"
.IX "Error Synchronization" "ESCAPE -1"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pescape ( func_id, in, store, out )
Pint	func_id;	\fIescape function identifier\fP
Pescape_in_data	*in;	\fIinput data for the function\fP
Pstore	store;	\fInot used. \fP
Pescape_out_data	**out;	\fIOUT not used \fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
\*f
enables or disables the enforced synchronization of error reporting.
.SS C Input Parameters
.IP \fIfunc_id\fP
The function identifier for this escape is \s-2PUESC_ERRSYNC\s+2,
defined in phigs.h to be -1.
.IP \fIin\fP
A pointer to a Pescape_in_data union, which contains the escape_in_u1 member
used by this escape function.
This member is defined in phigs.h as:
.sp .4
.ta .5i +\w'Perrsync     'u
.nf
struct {
.sp .2
	Perrsync	sync_on;
.sp .2
} escape_in_u1;
.fi
.RS
.IP \fIsync_on\fP
One of the following enumerated values:
.RS
.nf
.ta .25i +\w'-21 'u +\w'PERRSYNC_OFF     'u
.sp
	0	PERRSYNC_OFF	\fIAsynchronous Error Reporting\fP
	1	PERRSYNC_ON	\fISynchronous Error Reporting\fP
.sp
.fi
.RE
.RE
.IP \fIstore\fP
Not used.
.SS C Output Parameters
.IP \fIout\fP
There is no output data record for this escape.
.SS Execution
Errors detected by a \s-2PHIGS\s+2 function may not necessarily be
reported before that function returns to the application.
When this is the case, it is done to enhance performance.
When error reporting is delayed, all errors detected will eventually be
reported, but during a subsequent call to a PHIGS function.
When reported, each error will be correctly associated with the function
number of the function that detected the error.
.LP
Some applications may need to ensure that errors are reported
immediately. This can be indicated by \*f.
If the specified error synchronization mode is \s-2ON\s+2,
all errors detected by a \s-2PHIGS\s+2 function will be reported before
that function returns to the application.
If the error synchronization mode is \s-2OFF\s+2 (the default), errors
detected by a \s-2PHIGS\s+2 function will be reported either before that
function returns or
during a subsequent \s-2PHIGS\s+2 function call.
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "ERROR HANDLING (3P)"
.fi
