RETRIEVE PATHS TO DESCENDANTS

PRDEST

CALL SEQUENCE

CALL PRDEST (AFID, STRID, PTHORD, PTHDEP, IPTHSZ, N, ERRIND, OL, APTHSZ, PATHS)

INPUT PARAMETERS

INTEGER AFID

Archive file identifier

INTEGER STRID

Structure identifier

INTEGER PTHORD

Path order (PPOTOP,PPOBOT)

INTEGER PTHDEP

Path depth

INTEGER IPTHSZ

Size of path buffer

INTEGER N

Element of list of paths

OUTPUT PARAMETERS

INTEGER OL

Number of paths available

INTEGER APTHSZ

Actual size of the Nth structure path

INTEGER PATHS(2,IPTHSZ)

Nth structure path

PHIGS STATE

EFFECT

Returns the list of paths in the archive file that are reference by the structure STRID.

The complete path of descendant of a structure S is represented by a series of couplets: ((S, E0), (D1, E1), (D2, E2), ..., (DN, 0))

where D_n indicates the structure ID of the descendant and E_n indicates the element number of an EXECUTE STRUCTURE element of a single path. Each (D_i, E_i) structure element references structure element (D_i+1, E_i+1), from the highest parent structure (S, E0), defined by STRID, down to (DN, 0) the bottom-most structure. DN is a structure which is not referenced by any EXECUTE STRUCTURE in the archive.

The path depth PTHDEP and order PTHORD determine the position of each path to be returned.

Specify path depth = 0 to return each entire path.

Specify path depth = 0 and path order = PPOTOP to return a list of all paths (that are not identical) from the specified structure.

Specify path depth = 1 and path order = PPOTOP to return a list of all separate element references in the specified structure.

Specify path depth = 1 and path order = PPOBOT to return a list of all of the lowest-level structures in the structure network.

ERRORS

7

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

201

Ignoring function, the specified structure does not exist

207

Ignoring function, the specified path depth is less than zero (0)

SEE ALSO

open archive file, retrieve structures identifiers, retrieve structures, retrieve paths to ancestors