ABAPDESCRIBE_LIST - DESCRIBE LIST

ABAP Short Reference   CPI1466 during Backup  
This documentation is copyright by SAP AG.

DESCRIBE LIST

Short Reference

DESCRIBE LIST ${ ${NUMBER OF  ${LINES$|PAGES$} n$}
              $| ${LINE linno PAGE page$}
              $| ${PAGE pagno page_properties$} $}
              $[INDEX idx$].

Alternatives:

1. ... NUMBER OF ${LINES$|PAGES$} n

2. ... LINE linno PAGE page

3. ... PAGE pagno page_properties

Addition:

... INDEX idx

Effect

This statement assigns the properties of a list stored in a list buffer to the variables n, page, or the variables specified in page_properties.

System Fields

sy-subrc	Meaning
0	The list property was successfully specified.
4	The line specified in linno or page specified in pagno cannot be found.
8	The list level specified in idx cannot be found.

Note

The statement DESCRIBE LIST should only be used for completed lists, because not all properties of a list can be read when it is being created.

Addition

... INDEX idx

Effect

The list level can be specified with the addition INDEX, where idx expects a data object of type i, which contains the list index. The value of idx must be greater than or equal to 0. If the addition INDEX is not specified, the list level 0 (the basic list itself) is selected when the basic list is created and the list level at which the event was raised (sy-listi) is selected when a list event is processed. If the list level specified in idx does not exist, the variables are not changed and sy-subrc is set to the value 8.

Alternative 1

... NUMBER OF ${LINES$|PAGES$} n

Effect

If specified, LINES expects the number of lines, PAGES expects the number of pages in the list stored in n. n expects a data object of the type i. The number of lines is counted from the first to the last line described by an output statement and contains the page headers and page footers. The blank lines inserted automatically between the list pages are not counted.

Alternative 2

... LINE linno PAGE page

Effect

The corresponding page for the line number specified in linno is determined and stored in page. linno and page expect data objects of the type i. If the line specified in linno does not exist, page is not changed and sy-subrc is set to 4. The page headers and page footers are respected in the line count, but not the blank lines inserted automatically between the list pages.

Alternative 3

... PAGE pagno page_properties

Effect

Various properties page_properties for the page number specified in pagno are determined and passed to the specified variables. At least one addition must be specified after pagno. pagno expects the data type i. If the page specified in pagno does not exist, the variables are not changed and sy-subrc is set to the value 4.

Example

Determines some properties of the last page of the list currently displayed using two DESCRIBE statements in a list event.

ROGBILLS - Synchronize billing plans   BAL_S_LOG - Application Log: Log header data  
This documentation is copyright by SAP AG.

Length: 5463 Date: 20230328 Time: 171911     sap01-206 ( 86 ms )