NAME

ESCAPE -1 − enforce synchronized error reporting

SYNOPSIS

C Syntax

void
pescape ( func_id, in, store, out )
Pintfunc_id;escape function identifier
Pescape_in_data∗in; input data for the function
Pstorestore;not used.
Pescape_out_data∗∗out; OUT not used

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

ESCAPE -1 enables or disables the enforced synchronization of error reporting. 

C Input Parameters

func_id
The function identifier for this escape is PUESC_ERRSYNC, defined in phigs.h to be -1. 

inA 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:

struct {
Perrsyncsync_on;
} escape_in_u1;

sync_on
One of the following enumerated values:

0PERRSYNC_OFFAsynchronous Error Reporting
1PERRSYNC_ONSynchronous Error Reporting

storeNot used. 

C Output Parameters

outThere is no output data record for this escape. 

Execution

Errors detected by a PHIGS 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. 

Some applications may need to ensure that errors are reported immediately. This can be indicated by ESCAPE -1.  If the specified error synchronization mode is ON, all errors detected by a PHIGS function will be reported before that function returns to the application.  If the error synchronization mode is OFF (the default), errors detected by a PHIGS function will be reported either before that function returns or during a subsequent PHIGS function call. 

SEE ALSO

ERROR HANDLING (3P)

September 02, 1992