DiscardRow
Mon 01 January 2018Syntax
DiscardRow()
Description
Use the DiscardRow function to prevent a row from being added to a page scroll during Row Select processing. This function is valid only in RowSelect PeopleCode. When DiscardRow is called during RowSelect processing, the current row is skipped (not added to the scroll). Processing then continues on the next row, unless the StopFetching function has also been called, in which case no more rows are added to the page.
If you try to discard a row and it's the only row in the scroll, the row is not discarded. You will still have one blank row in your scroll.
DiscardRow has the same functionality as the Warning function in the RowSelect event. The anomalous behavior of Warning is supported for compatibility with previous releases of PeopleTools.
Note: RowSelect processing is used infrequently, because it is more efficient to filter out rows of data using a search view or an effective-dated record before the rows are selected into the component buffer from the database server.
In row select processing, the following actions occur:
-
The Component Processor checks for more rows to add to the component.
-
The Component Processor initiates the RowSelect event, which triggers any RowSelect PeopleCode associated with the record field or component record.
This enables PeopleCode to filter rows using the StopFetching and DiscardRow functions. StopFetching causes the system to add the current row to the component, and then to stop adding rows to the component. DiscardRow filters out a current row, and then continues the row select process.
-
If neither the StopFetching nor DiscardRow function is called, the Component Processor adds the rows to the page and checks for the next row.
The process continues until there are no more rows to add to the component buffers. If both StopFetching and DiscardRow are called, the current row is not added to the page, and no more rows are added to the page.
Image: Row Select Processing Logic
The following flowchart shows this row select processing logic:
Parameters
None.
Returns
None.