HP 3000 Manuals

RWINFO [ HP Business BASIC/XL Reference Manual ] MPE/iX 5.0 Documentation


HP Business BASIC/XL Reference Manual

RWINFO 

The RWINFO function is a Report Writer function that returns various
pieces of information that may be useful in controlling the Report
Writer.  Table 5-8 shows the values returned.  If there is no active
report, -1 is returned.

          Table 5-8.  RWINFO Return Values 

-------------------------------------------------------------------------------------------
|                                                                                         |
|    Input Value                                 Description                              |
|                                                                                         |
-------------------------------------------------------------------------------------------
|                                                                                         |
|         1         Page Size.  Zero indicates an infinite page size.                     |
|                                                                                         |
|         2         Effective Page Size.  Defined as page_size - # blank lines at top - # |
|                   blank lines at bottom - size of PAGE HEADER - size of PAGE TRAILER.   |
|                                                                                         |
|         3         NUMLINE value.                                                        |
|                                                                                         |
|         4         Lines left on current page.  Includes the page trailer and blank      |
|                   lines at the bottom.  Includes the page header if used in the PAGE    |
|                   HEADER section.  Returns zero for an infinite size page.              |
|                                                                                         |
|         5         Lines left on effective page.  Equal to effective page size minus     |
|                   NUMLINE. Returns zero for an infinite size page.                      |
|                                                                                         |
|         6         Returns 1 if last page break was caused by DETAIL LINE statement.     |
|                   Returns 0 if any other statement causes a page break.                 |
|                                                                                         |
|         7         PAGENUM value.                                                        |
|                                                                                         |
|         8         Number of pages left to suppress.                                     |
|                                                                                         |
|         9         Number of logical pages produced.  This number is not affected by     |
|                   PAGENUM, and increments even when output is suppressed.               |
|                                                                                         |
|        10         LASTBREAK value.                                                      |
|                                                                                         |
|        11         LEFT MARGIN column.  Reflects the value given in the LEFT MARGIN      |
|                   statement, even if the left margin is not used.                       |
|                                                                                         |
|        12         Current summary level.  Set during all HEADER and TRAILER sections,   |
|                   and during BREAK statement evaluation.  Returns zero when not in a    |
|                   break condition.                                                      |
|                                                                                         |
|        13         PAGE HEADER size.                                                     |
|                                                                                         |
|        14         PAGE TRAILER size.                                                    |
|                                                                                         |
|        15         Returns 1 if DETAIL LINE causes a break.  Otherwise, zero is          |
|                   returned.                                                             |
|                                                                                         |
-------------------------------------------------------------------------------------------

Syntax 

RWINFO(input_value)

Parameters 

input_value      A number specifying the information that RWINFO is to
                 return.  See Table 5-8 above for specific values.

Examples 

     110  In_value = 7
     120  RWvalue= RWINFO(In_value)  !RWvalue receives the PAGENUM value.



MPE/iX 5.0 Documentation