NAME

ESCAPE -2 − inquire workstation’s display and window information

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;pointer to the buffer
Pescape_out_data∗∗out; OUT output data of the function

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

ESCAPE -2 returns display and window information for the specified workstation. 

C Input Parameters

Applications using the C binding must create a buffer to be used by this function as memory space for storing data associated with the device state.  This buffer is passed as the store argument. 

The store buffer is a data area managed by PHIGS. While the application is responsible for creating the inital buffer through a call to CREATE STORE, PHIGS manages this area such that there is sufficient memory for the specific inquiry. The data record within the store buffer is accessed by the pointer pointed to by out. 

func_id
The function identifier for this escape is PUESC_DPYINFO, which is defined in phigs.h to be -2. 

inA pointer to a Pescape_in_data union, which contains the escape_in_u2 member used by this escape function.  This member is defined in phigs.h as:

struct {
Pintws_id;
} escape_in_u2;

ws_idThe indentifier of the workstation for which the display and window information is to be returned. 

storeThe memory buffer PHIGS is to use for storing the information returned.  This buffer must exist prior to calling this function (see CREATE STORE (3P)). 

C Output Parameters

outA pointer to a pointer to a Pescape_out_data union, which contains the escape_out_u2 member used by this escape function.  PHIGS copies a pointer to the requested information to the variable pointed to by this parameter.  This member is defined in phigs.h as:

struct {
Pinterr_ind;
Display∗display;/∗ may be returned as NULL ∗/
XIDdrawable_id;
XIDinput_overlay_id;/∗ will be 0 if category not OUTIN ∗/
char∗display_name;
} escape_out_u2;

err_ind will contain the error number of any error detected by this function. 

display is a pointer to the Display used by the PHIGS workstation.  This pointer may be returned as NULL if PHIGS is not maintaining a connection to the display in the application’s process.  If display is NULL, the display_name parameter, also returned by this escape, can be used to identify the server used by the PHIGS workstation. 

drawable_id is the X window id of the drawable used by the specified workstation for PHIGS output. 

input_overlay_id is the X window id of the window used by the specified workstation for Locator, Pick, and Stroke input. 

display_name is the name of the display used by the specified workstation. 

Execution

The INQUIRE WORKSTATION’S DRAWABLE AND DISPLAY escape returns Display and window information associated with the specified workstation.  While intended to be used for x_tool type workstations, where the application doesn’t create the window or establish the display connection, this escape will also work with x_drawable workstations. 

ERRORS

003Ignoring function, function requires state (PHOP, WSOP, ∗, ∗)

054Ignoring function, the specified workstation is not open. 

SEE ALSO

ESCAPE (3P)
CREATE STORE (3P)
DELETE STORE (3P)

September 02, 1992