NAME

INQUIRE LIST OF LIGHT SOURCE INDICES - inquire for list of light source indices defined on workstation

SYNOPSIS

C Syntax

void

pinq_list_light_src_inds ( ws, length, start, error_ind, indices, total_length )

Pint       ws;              workstation identifier
Pint       length;          length of application list
Pint       start;           starting position
Pint       * error_ind;     OUT error indicator
Pint_list  * indices;       OUT list of polyline indices
Pint       * total_length;  OUT length of list in PHIGS

FORTRAN Syntax

SUBROUTINE pqlsi ( WKID, ILS, ERRIND, NLSI, LSI )

INTEGER      WKID        workstation identifier
INTEGER      ILS         index into the light source list
INTEGER      ERRIND      OUT error indicator
INTEGER      NLSI        OUT number of light sources indices
INTEGER      LSI         OUT ILS-th element of light sources

Required PHIGS Operating States

(PHOP, WSOP, * ,* )

DESCRIPTION

Purpose

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

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

C Input Parameters

ws

The workstation identifier.

length

The number of ints in the indices output parameter for which the application has allocated memory. length is the number of list elements that the system can return in indices.ints. If a value of 0 is used here, then no data is returned in the indices.ints list, but the total number of elements is returned in total_length.

start

Starting position of inquiry. The elements in the list, beginning with the item number specified by start, are copied sequentially into indices.ints until indices.ints is full or all the elements have been copied.

C Output Parameters

error_ind

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

indices This is a pointer to a Pint_list structure. This structure specifies both an integer

value indicating the number of light source representations and a pointer to a list

specifying the index numbers of the light source representations. Pint_list is defined in phigs.h as follows:

typedef struct {

Pint  num_ints;    /* number of light sources * /
Pint  * ints;      /* list of light source indices * /

} Pint_list;

The num_ints component specifies the number of elements in the list. The ints component is a pointer to a list num_ints long.

The application must allocate memory for length elements in the list of ints.

total_length

A pointer to an integer, which returns the total number of elements in the list of light source indices. This is the value required for length if all elements in the list are to be returned.

FORTRAN Input Parameters

WKID

The workstation identifier.

ILS

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

FORTRAN Output Parameters

ERRIND

A pointer to the location in which to store the error number of any error that this function detects

NLSI

The number of indices in the light source list.

LSI

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

Execution

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

If the inquired information is not available, then 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 this function detects an error

ERRORS

003

Ignoring function, function requires state (PHOP, WSOP, * ,* )

054

Ignoring function, the specified workstation is not open

059

Ignoring function, the specified workstation does not have output capability (that is, the workstation category is not OUTPUT, OUTIN, or MO)

SEE ALSO

INQUIRE LIGHT SOURCE REPRESENTATION (3PP)

SET LIGHT SOURCE REPRESENTATION (3PP)