Retro video games delivered to your door every month!
Click above to get retro games delivered to your door ever month!
X-Hacker.org- Flipper 6.0 Help File - <b>prt_area()</b> http://www.X-Hacker.org [<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
PRT_AREA()
   Prints a portion of the screen.

   Syntax
         nOk = PRT_AREA(nX1,nY1,nX2,nY2,nWidth,nHeight,nLeftMargin,nTopMargin)

   Arguments
         nX1         Sets the X value for the top left hand corner of the
                     area.
         nY1         Sets the Y value for the top left hand corner of the
                     area.
         nX2         Sets the X value for the bottom right hand corner of the
                     area.
         nY2         Sets the Y value for the bottom right hand corner of the
                     area.
         nWidth      Sets the output width.
         nHeight     Sets the output height.
         nLeftMargin Sets the output left margin.
         nTopMargin  Sets the output top margin.

   Returns
         nOk         Returns a 0 if it failed, a 1 if it succeeds.

   Description
         PRT_AREA() prints the portion of the screen defined by the
         rectangle bounded by the first four arguments to a printer image
         whose output size and location are specified by the next four
         arguments. The source corners are specified by nX1,nY1 and nX2,nY2.
         These define the upper left hand corner and the lower right hand
         corner of the area to be printed respectively. Any source coordinate
         outside the screen or viewport will be clipped, thus you can print a
         complete screen or the current viewport by using values that you know
         are outside the the video screen.

         The output size is specified by width and height, and the location
         by left_margin and top_margin. These values can be specified in
         inches, centimeters or absolute scaling. By default, the output is
         scaled in inches but can be changed with the PRT_SCALE() function.
         The values are specified in multiples of 100. Thus if you want the
         image to be 3.4 inches wide and 2.34 inches high you would use the
         values 340 and 234 for width and height respectively. The same
         applies for left_margin and top_margin. You can preserve the
         screen's aspect ratio by using 0 for either the width or the height.
         For example, if you specify the width to be 510 (5.1 inches) and the
         height to be 0, then the output image will be 5.1 inches wide and the
         height will be whatever is needed to have the same aspect ratio as on
         the screen. You should find this feature very handy.
         If the operation is successful, a 1 is returned. Otherwise a 0
         is returned and the error will be displayed.

Possible Errors
-----------------------
1 - Insufficient memory on the heap. Generally, only a few hundred
    bytes are requested.
2 - One of the values in the printer's escape sequence was illegal.
    Correct the printer's record in the PRX_EDIT table editor.
3 - The data could not be properly written.

Online resources provided by: http://www.X-Hacker.org --- NG 2 HTML conversion by Dave Pearson