graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQMTR - Inquire Marker Type Representation

GPQMTR (wsid, mtype, errind, format, length, data)

Note:

This subroutine is a Workstation State List (WSL) inquiry. For an overview, see "WSL Inquiries"

Purpose

Use GPQMTR to inquire the current marker pattern in the specified entry in the marker type table of the specified workstation.

If the inquired information is available, then the graPHIGS API sets the error indicator to zero and returns the values in the output parameters. If the inquired information is unavailable, then the error indicator (errind) contains an error number indicating the reason, and the values returned in the output parameters are unpredictable.

Parameters

wsid -- specified by user, fullword integer

Workstation identifier.

mtype -- specified by user, fullword integer

Marker type table index (>=1)

errind -- returned by the graPHIGS API, fullword integer

Error indicator. If the error indicator is zero, the request has been completed. Otherwise, one of the following errors exists:

25: SPECIFIED WORKSTATION DOES NOT EXIST
35: WORKSTATION HAS ONLY INPUT CAPABILITIES
69: MARKER TYPE VALUE < ONE
70: SPECIFIED MARKER TYPE NOT AVAILABLE ON WORKSTATION
274: THIS FUNCTION IS NOT SUPPORTED BY THE WORKSTATION

format -- returned by the graPHIGS API, fullword integer

Marker pattern format (1=VECTOR )

length -- returned by the graPHIGS API, fullword integer

Length of the entire marker pattern definition.

data -- returned by the graPHIGS API, data array

Marker pattern definition data. Values returned to this parameter depend on the marker pattern format. The application must supply storage for this parameter that is large enough to contain the maximum data that the specified workstation supports.

Format 1=graPHIGS VECTOR FONT

      -------------------
    0 |             flag|  halfword integer
      |-----------------|
    2 |         reserved|  halfword integer
      |-----------------|
    4 |     top|  bottom|  two 8-bit signed integers
      |-----------------|
    6 |   right|    left|  two 8-bit signed integers
      |-----------------|
    8 |        draw/move|  two 8-bit signed integers
      |-----------------|
   10 |        draw/move|
      /                 /
      /                 /
      |                 |
      |                 |
      -------------------

Each field specifies:

flag

   0       1                       15
   -----------------------------------
   | fill |       reserved           |
   | flag |                          |
   -----------------------------------

If the fill flag=1, and the workstation supports filled characters, then the marker will be filled.

reserved

Must be 0.

top, bottom, right, left

Four 8-bit signed integers specifying the marker rectangle measured from the origin (top > bottom, right > left)

          ------------- ^ 
          |     |     | |
          |     |     | | top
          |-----|-----|
          |     |     | | bottom
          |     |     | | 
          ------------- v
          <----- ----->
           left   right

draw/move

A pair of 8-bit strings specifying a relative draw/move starting from the origin (the marker position) with the format sxxxxxx1 and syyyyyyb, where s is sign bit and b is blank bit. When the blank bit=1, then the sxxxxxx and syyyyyy strings specify a relative move; otherwise, they specify a relative draw.

Error Codes

None

Related Subroutines

GPMTR: Set Marker Type Representation
GPQMTF: Inquire Marker Type Facilities
GPQXTX: Inquire Extended Text Facilities

RCP code

201339152 (X'0C003110')