pad_inq_position()

PAD_$INQ_POSITION                 Domain/OS                  PAD_$INQ_POSITION


NAME
     pad_$inq_position - find the output cursor

SYNOPSIS (C)
     #include <apollo/base.h>
     #include <apollo/pad.h>

     void pad_$inq_position(
          ios_$id_t &stream_id,
          short *y,
          short *x,
          status_$t *status)

SYNOPSIS (Pascal)
     %include '/sys/ins/base.ins.pas';
     %include '/sys/ins/pad.ins.pas';

     procedure pad_$inq_position(
          in stream_id: ios_$id_t;
          out x: integer;
          out y: integer;
          out status: status_$t);

SYNOPSIS (FORTRAN)
     %include '/sys/ins/base.ins.ftn'
     %include '/sys/ins/pad.ins.ftn'

           integer*4 status
           integer*2 stream_id, x, y

           call pad_$inq_position(stream_id, x, y, status)

DESCRIPTION
     Pad_$inq_position reports the location of the output cursor in the pad
     described by stream_id.

     If this procedure is executed when the cursor is inside a frame, x and y
     are relative to the upper left corner of the frame.  If the cursor is not
     in a frame, x represents the position on the line and y is undefined.

     stream_id
          The stream ID of the pad of interest.

     x    The x-coordinate of the output cursor divided by the pad's scale
          factor.  The x-coordinate is the cursor's position on a line.  Since
          the default horizontal scale factor is the width of the current
          font, the position returned in x is generally the number of charac-
          ters (columns) from the beginning of the line.

     y    The y-coordinate of the output cursor divided by the pad's scale
          factor.  In a frame, the y-coordinate is relative to the upper left
          corner of the frame.  Since the default vertical scale factor is the
          height of the current font, the position returned in y is generally
          the number of lines from the top of the frame.  If the cursor is not
          in a frame, the y-coordinate is undefined.

     status
          The completion status.

SEE ALSO
     pad_$cooked, pad_$cpr_enable, pad_$inq_full_window, pad_$inq_icon,
     pad_$inq_view, pad_$raw.
Museum
