INQUIRE LIST OF LIGHT SOURCE INDICES(3P+) — MISC. REFERENCE MANUAL PAGES

NAME

INQUIRE LIST OF LIGHT SOURCE INDICES − inquire the list of light source indices defined on a workstation

SYNOPSIS

C Syntax

void
pinqlightsrcind ( wsid, length, start, error_ind, indices, total_length )
Pintwsid;workstation identifier
Pintlength;number of indices requested
Pintstart;starting position
Pint∗error_ind;OUT error indicator
Pintlst∗indices;OUT light source indices
Pint∗total_length;OUT length of list in PHIGS

FORTRAN Syntax

SUBROUTINE pqlsi ( WKID, ILS, ERRIND, NLSI, LSI )
INTEGERWKIDworkstation identifier
INTEGERILSindex into the light source list
INTEGERERRINDOUT error indicator
INTEGERNLSIOUT number of light sources indices
INTEGERLSIOUT ILS-th element of light sources

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE LIST OF LIGHT SOURCE INDICES inquires a list of light source indices defined on a workstation.

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 number of indices requested.

startThe first index to be returned.

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 containing the list of light source indices. A Pintlst structure is defined as:

typedef struct {
Pintnumber;/∗ number of light sources ∗/
Pint∗integers;/∗ list of light sources ∗/
} Pintlst;

total_length
A pointer to an integer which returns the total length of the list of light source indices.

FORTRAN Input Parameters

WKIDThe workstation identifier.

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

FORTRAN Output Parameters

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

NLSIThe number of indices in the light source list.

LSIThe requested element from the list of defined light source 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

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