INQUIRE LIGHT SOURCE FACILITIES(3P+) — MISC. REFERENCE MANUAL PAGES

NAME

INQUIRE LIGHT SOURCE FACILITIES − inquire list of workstation light source facilities for a specified workstation type

SYNOPSIS

C Syntax

void
pinqlightsrcfacil ( wstype, length, start, error_ind, total_length, facilities )
Pwstypewstype;workstation type
Pintlength;length of list requested
Pintstart;starting position
Pint∗error_ind;OUT error indicator
Pint∗total_length;OUT length of list in PHIGS
Plightsrcfac∗facilities;OUT light source facilities

FORTRAN Syntax

SUBROUTINE pqlsf ( WKTYPE, ILS, ERRIND, NLSI, LSI, NPDEF )
INTEGERWKTYPEworkstation type
INTEGERILSindex into the light source list
INTEGERERRINDOUT error indicator
INTEGERNLSIOUT number of light sources indices
INTEGERLSIOUT ILS-th element of light sources
INTEGERNPDEFOUT number of predefined indices

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE LIGHT SOURCE FACILITIES obtains a list of workstation light source facilities.

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 for which the light source facilities are being inquired.

lengthThe number of elements requested.

startThe starting position.

C Output Parameters

error_ind
A pointer to the location to store the error number.

total_length
A pointer to the location to store the total length of the list.

facilities
A pointer to the location in which to return the light source facilities. Plightsrcfac is defined as:

typedef struct {
Pintlsttypes;/∗ types of light source supported ∗/
Pintmax;/∗ max. no. of simultaneously active lights ∗/
Pintpredefined/∗ number of predefined bundles ∗/
} Plightsrcfac;

Pintlst is a pointer to the types of light sources that are supported. 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 Pintlst structure must contain a pointer to an application supplied buffer. This buffer must be at least as large as the corresponding length parameter.

FORTRAN Input Parameters

WKTYPE
The workstation type for which the light source facilities are being inquired.

ILSThe index of the entry desired from the list of light source indices.

FORTRAN Output Parameters

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

NLSIThe number of light source types supported.

LSIThe requested element from the defined list of light source indices.

NPDEF
The number of predefined light source type indices.

Execution

If the inquired information is available, the error indicator is returned as zero and values are 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 following 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 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