INQUIRE LIST OF GENERAL INTERIOR INDICES(3P+) — MISC. REFERENCE MANUAL PAGES

NAME

INQUIRE LIST OF GENERAL INTERIOR INDICES − inquire the list of general interior indices defined on a workstation

SYNOPSIS

C Syntax

void
pinqgenintind ( wsid, length, start, error_ind, indices, total_length )
Pintwsid;workstation identifier
Pintlength;length of list of interior indices to return
Pintstart;index of first element of list to return
Pint∗error_ind;OUT error indicator
Pintlst∗indices;OUT list of general interior indices
Pint∗total_length;OUT length of list in PHIGS

FORTRAN Syntax

SUBROUTINE pqlgii ( WKID, IIND, ERRIND, NIND, GIND )
INTEGERWKIDworkstation identifier
INTEGERIINDlist element requested
INTEGERERRINDOUT error indicator
INTEGERNINDOUT number of general interior indices
INTEGERGINDOUT IIND-th element of list of available indices

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE LIST OF GENERAL INTERIOR INDICES returns the list of currently defined general interior indices in the specified workstation state list.

This is a SunPHIGS Extension function based on PHIGS+ and is not part of the PHIGS standard.

C Input Parameters

All of the following data types are predefined in phigs.h.

wsidThe workstation identifier.

lengthThe length of the portion of the list of general interior indices to return.

startThe starting position of the portion of the list to return.

C Output Parameters

error_ind
A pointer to the location to store the error number of any error detected by this function.

indicesA pointer to a Pintlst structure which returns the list of general interior indices. Pintlst is defined as:

typedef struct {
Pintnumber;/∗ number of Pints in list ∗/
Pint∗integers;/∗ list of integers ∗/
} Pintlst;

Prior to calling this function, the integers field of the structure must be a valid pointer to an array of at least length integers.

total_length
A pointer to an integer which returns the total length of the list of general interior indices.

FORTRAN Input Parameters

WKIDThe workstation identifier.

IINDThe list element requested.

FORTRAN Output Parameters

ERRIND
The error number of any errors detected by this function.

NINDThe number of defined general interior indices.

GINDThe IIND-th element of the list of defined general interior indices.

Execution

If the inquired information is available, the error indicator is returned as zero and the requested information is returned in the output parameters.

If the inquired information is not available, the values returned in the output parameters are undefined and the error indicator is set to one of the below error numbers to indicate the reason for nonavailability.

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

059Ignoring function, the specified workstation does not have output capability (i.e., the workstation category is neither OUTPUT, OUTIN, nor MO)

Museum