1 08/23/83   display_builtins, dib
 2 
 3 Syntax:  [display_builtins STR]
 4 
 5 
 6 Function:  returns the current value of the builtin named by STR.  This
 7 request can only be used as an active request.  It is used within a
 8 formatted report produced by the display request to obtain the current
 9 value of the specified builtin.  It is an error to use this request
10 anywhere except in a header/footer or editing string within a report
11 produced by the display request.
12 
13 STR can be any one of the following builtins:
14 
15 
16 current_pass_number
17    the number of the current pass.  This number begins at 1 and is
18    incremented by 1 for each additional formatting pass over the
19    report.
20 
21 current_row_number
22    the number of the current row of the report.
23 
24 first_row
25    "true" if the current row is the first row of the report.  "false"
26    if it is not the first row of the report.
27 
28 
29 last_page_number
30    the number of the last page of the report, or "0" if it is the first
31    pass over the report.  After each formatting pass over the report
32    this number is updated with the number of the last page.
33 
34 last_pass
35    "true" if this is the last formatting pass of the report.  "false"
36    if this is not the last pass of the report.
37 
38 last_row
39    "true" if the current row is the last row of the report.  "false" if
40    the current row is not the last row of the report.
41 
42 
43 last_row_number
44    the number of the last row of the table, or "0" if it is the first
45    pass over the report.  After the first formatting pass over the
46    report this number is set to the number of the last row.
47 
48 page_number
49    the number of the current page of the report.
50 
51 previously_processed_row
52    "true" if the current row had been processed on the preceding page,
53    but the row value would not fit and had to be deferred to the
54    current page.  "false" if this is the first time the current row has
55    been processed.