ScrollFlush function
Syntax
ScrollFlush(scrollpath)
Where scrollpath is:
[RECORD.level1_recname, level1_row, [RECORD.level2_recname, level2_row, ]RECORD.target_recname
To prevent ambiguous references, you can use SCROLL. scrollname, where scrollname is the same as the scroll level’s primary record name.
Description
Use the ScrollFlush function to remove all rows inside the target scroll area and frees its associated buffer.
Note:
This function remains for backward compatibility only. Use the Flush rowset method instead.
Rows that are flushed are not deleted from the database. This function is often used to clear a work scroll before a call to ScrollSelect.
Parameters
| Parameter | Description |
|---|---|
|
scrollpath |
A construction that specifies a scroll level in the component buffer. |
Returns
None.
Example
The following example clears the level-one scroll then fills the level-one and level-two scrolls.
/* Throw away all rows */
ScrollFlush(RECORD.DBFIELD_VW);
/* Fill in new values */
&FIELDSEL = "where FIELDNAME like '" | FIELDNAME | "%'";
&ORDERBY = " order by FIELDNAME";
ScrollSelect(1, RECORD.DBFIELD_VW, RECORD.DBFIELD_VW, &FIELDSEL | &ORDERBY);
ScrollSelect(2, RECORD.DBFIELD_VW, RECORD.DBFIELD_LANG_VW, RECORD.DBFIELD_LANG_VW, &FIELDSEL | " and LANGUAGE_CD = :1" | &ORDERBY, DBFIELD_SRCH.LANGUAGE_CD);
Related Topics
- PeopleCode API Reference: Flush method: Rowset class
- PeopleCode Developer’s Guide: Understanding Data Buffer Access
- PeopleCode Developer’s Guide: Specifying Data with References Using Scroll Path Syntax and Dot Notation
- RowFlush function
- RowScrollSelect function
- RowScrollSelectNew function
- ScrollSelect function
- ScrollSelectNew function