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