INQUIRE WORKSTATION CONNECTION AND TYPE(3P) — SUNPHIGS LIBRARY

NAME

INQUIRE WORKSTATION CONNECTION AND TYPE− inquire a workstation’s connection identifer and type.

SYNOPSIS

C Syntax

void
pinqwsconntype ( ws, size, error_ind, buffer, conn_id, total_size, ws_type )
Pintws;workstation identifier
Pintsize;size of application buffer
Pint∗error_ind;OUT error indicator
Pchar∗buffer;OUT pointer to buffer
Pconnid∗conn_id;OUT connection identifier
Pint∗total_size;OUT total size of buffer
Pwstype∗ws_type;OUT workstation type

FORTRAN Syntax

SUBROUTINE pqwkc ( WKID, ERRIND, CONID, WTYPE )
INTEGERWKIDworkstation identifier
INTEGERERRINDOUT error indicator
INTEGERCONIDOUT connection identifier
INTEGERWTYPEOUT workstation type

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Use INQUIRE WORKSTATION CONNECTION AND TYPE 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 specific workstation type 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 OPEN WORKSTATION for descriptions of the possible connection identifiers and generic workstation types.

C Input Parameters

Applications using the C binding must allocate a buffer to be used by this function as memory space for storing portions of the data. This buffer is passed as the buffer argument. The size of the buffer, in bytes, must be passed in the size argument. The required size is returned in the argument total_size. The caller can determine the required size by calling this function with size set to zero, in which case PHIGS will return the size needed in total_size. After allocating a buffer of the required size a subsequent call can be made to retrieve all the data. The size in general will not be zero but may be, depending on the workstation type.

Error PEBUFSPAC (2200) is returned if size is too small, but not if it’s zero.

wsThe workstation identifier of the workstation in question.

sizeThe size, in bytes, of buffer.

error_ind
The error indicator. See the Execution section below for a description of its use. See the Errors section below for the possible values it may return.

bufferA pointer to the buffer, allocated by the application, to be used by PHIGS to store portions of the returned data.

conn_id
A pointer to a Pconnid variable in which to return the connection identifer. Pconnid is defined in phigs.h as:

typedef char ∗ Pconnid;

total_size
A pointer to an integer in which PHIGS returns the size of the buffer needed, in bytes, to return all the information.

ws_type
A pointer to a Pwstype variable in which to store the workstation type.

FORTRAN Input Parameters

WKIDThe workstation identifier of the workstation in question.

ERRIND
The error indicator. See the Execution section below for a description of its use. See the Errors section below for the possible values it may return.

CONID
The connection id of the workstation.

WTYPE
The specific workstation type associated with the workstation.

Execution

INQUIRE WORKSTATION CONNECTION AND TYPE returns the specific workstation type and connection identifier associated with the specified workstation. See OPEN WORKSTATION for a description of the possible connection identifiers and workstation types.

Except in the case mentioned in the C Parameters sections above, if an error is detected by this function the error indicator will indicate the error number of the error detected and no other output data will be returned. If no error is detected, the error indicator will be set to zero and the inquired information will be available in the output parameters. Since this is an inquiry function, ERROR HANDLING is not invoked when an error is detected by this function.

ERRORS

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

054Ignoring function, the specified workstation is not open

2200C: Buffer overflow in input or inquiry function

Museum

Related Articles