INQUIRE GENERAL INTERIOR FACILITIES(3P+) — MISC. REFERENCE MANUAL PAGES

NAME

INQUIRE GENERAL INTERIOR FACILITIES − inquire the general interior facilities of a workstation type

SYNOPSIS

C Syntax

void
pinqgenintfacil ( wstype, length, start, error_ind, facil, tot_length )
Pwstypewstype;workstation type
Pintlength;length of list of general interior types to return
Pintstart;index of first element of list to return
Pint∗error_ind;OUT error indicator
Pgeninterfac∗facil;OUT general interior facilities
Pint∗tot_length;OUT total length of general interior types list

FORTRAN Syntax

SUBROUTINE pqgif ( WKTYPE, ITYPE, ERRIND, NTYPES, TYPE, NPGI )
INTEGERWKTYPEworkstation type
INTEGERITYPElist element requested
INTEGERERRINDOUT error indicator
INTEGERNTYPESOUT number of available general interior types
INTEGERTYPEOUT ITYPE-th element of list of available types
INTEGERNPGIOUT number of predefined general interior indices

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE GENERAL INTERIOR FACILITIES returns the list of supported general interior types and the number of predefined general interior table entries in the workstation type’s workstation description table.

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.

wstypeThe workstation type.

lengthThe length of the portion of the list of general interior types 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.

facilA pointer to a Pgeninterfac structure by which to return the requested information. Pgeninterfac is defined as:

typedef struct {
Pintlsttypes;/∗ list of general interior types supported ∗/
Pintpredefined;/∗ number of predefined general indices ∗/
} Pgeninterfac;

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.

tot_length
A pointer to the location to store the total length of the list of supported general interior types.

FORTRAN Input Parameters

WKTYPE
The workstation type.

ITYPE
The index of the entry desired from the list of supported general interior types.

FORTRAN Output Parameters

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

NTYPES
The number of entries in the list of supported general interior types.

TYPEThe requested entry from the list of supported general interior types.

NPGIThe number of predefined 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

002Ignoring function, function requires state (PHOP, ∗, ∗, ∗)

051Ignoring function, this information is unavailable for this workstation type

052Ignoring function, workstation type not recognized by the implementation

062Ignoring function, this information is not available for this MO workstation type

Museum