graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPRQPK - Request Pick

GPRQPK (wsid, device, length, status, depth, pickpath)

Purpose

Use GPRQPK to have the graPHIGS API execute a request to the specified pick device.

The pick path information is returned in the order specified in the Initialize Pick (GPINPK) subroutine, that is, 1=TOP_FIRST or 2=BOTTOM_FIRST If GPINPK has not been called, the default value is 1=TOP_FIRST

Parameters

wsid -- specified by user, fullword integer

Workstation identifier.

device -- specified by user, fullword integer

Pick device number (>=1)

length -- specified by user, fullword integer

Length of pick path array provided by the application in which the graPHIGS API returns the pick information (>=0)

This value is specified as the size of the pick path array in pick path entries. If the actual pick information is longer than the pickpath array provided by the application, the overage is truncated.

status -- returned by the graPHIGS API, fullword integer

Status (1=NONE, 2=OK )

depth -- returned by the graPHIGS API, fullword integer

Depth of pick path returned in the pickpath parameter.

pickpath -- returned by the graPHIGS API, array of fullword integers

Pick path to picked primitive. List of pick path triplets. Each triplet represents the structure identifier, the pick identifier, and the element number of the pick path.

If the actual pick information is longer than the pick path array provided by the application, the overage is truncated.

Pick path data is returned in the pickpath parameter in the following order: Entry 1, Entry 2, ...Entry N.

          ----------------------------------------------------------
 Entry 1  |  Structure ID 1  |    Pick ID 1     |    Element #1    |
          |                  |                  |                  |
 Entry 2  |  Structure ID 2  |    Pick ID 2     |    Element #2    |
          |                  |                  |                  |
   .      |        .         |        .         |        .         |
   .      |        .         |        .         |        .         |
   .      |        .         |        .         |        .         |
          |                  |                  |                  |
 Entry N  |  Structure ID N  |    Pick ID N     |    Element #N    |
          ----------------------------------------------------------

Error Codes

25: SPECIFIED WORKSTATION DOES NOT EXIST
140: DEVICE NUMBER < ONE OR DEVICE NOT AVAILABLE
141: INPUT DEVICE NOT IN CORRECT MODE
168: INPUT DEVICE IS CURRENTLY OWNED BY ANOTHER CONNECTION
505: LENGTH OF RETURN ARRAY < ZERO

Related Subroutines

GPADCN: Add Class Name to Set
GPINPK: Initialize Pick
GPPKF: Set Pick Filter
GPPKID: Set Pick Identifier
GPPKMO: Set Pick Mode
GPQLI: Inquire List of Logical Input Devices
GPRCN: Remove Class Name from Set
GPRQXP: Request Extended Pick

RCP code

201335563 (X'0C00230B')