gpr_inq_text_extent() — Apollo Domain/OS SR10.3.5

GPR_$INQ_TEXT_EXTENT              GPR Calls               GPR_$INQ_TEXT_EXTENT


NAME
     gpr_$inq_text_extent - returns the extent of a string.

FORMAT
     gpr_$inq_text_extent (string, string_length, size, status)

DESCRIPTION
     This routine returns the x- and y- offsets a string spans when written by
     gpr_$text.

   Input Parameters
     string
          A string, in gpr_$string_t format.  This is a 256-element character
          array.

     string_length
          Number of characters in the string.  This is a 2-byte integer.  The
          maximum value is 256.

   Output Parameters
     size Width and height of the area the written string will occupy, in
          gpr_$offset_t format.  This data type is 4 bytes long.

     status
          Completion status, in status_$t format.

SEE ALSO
     gpr_$inq_text16_extent.

NOTES
     When the text path is gpr_$right or gpr_$left, the width is the x-offset.
     When the text path is gpr_$up or gpr_$down, the width is the y-offset.

     To change the direction of text, use gpr_$set_text_path.

     Use the gpr_$inq_text16_extent routine to inquire the extent of a  string
     of 16-bit characters.
Museum
