[Tip] How to correctly iterate a Record List inside an Extension

Hi guys,
 
In the last few months I've been seeing lots of Extensions with incorrect patterns used for iterating Record Lists.
These wrong patterns can produce wrong and unexpected behaviors/results, the most common being missing some entries when doing the iteration.
 
This post shows how to correctly iterate a Record List in an extension.
 
The following code snippet illustrates the correct pattern:
 
 
    try {
                                                                             
        // Call Record List "StartIteration" to ensure the iteration starts from the beginning of the list
        recordList.StartIteration();
                                                                                             
        // Record List "Eof" property indicates if we're in the end of the list
        while (!recordList.Eof) {

            // access "CurrentRec" to retrieve current record information
            string attrName = recordList.CurrentRec.ssSTMyEntity.ssName;
 
            // call "Advance" to move to the next record in the list
            recordList.Advance();
        }
    }  finally {
                                                                           
        // in the finally, call "EndIteration" to indicate that we're no longer iterating the record
        // we must call this function to allow other record list operations, e.g., list-append, list-remove, etc
        recordList.EndIteration();
    }
 
If you are using extensions developed in your company and have actions that use Record Lists, and are having unexpected behavior, you should look into the source code to check if the correct iteration pattern is being used, and fix it if that is the case.
 
If you have any question or comments, please let me know.
 
 
Regards,
João Portela