Terminate - 9 Call - Finalist - 10.0

Finalist Compatibility Interface (CI) Migration Guide

Product type
Software
Portfolio
Verify
Product family
Data Quality - Postals
Product
Finalist
Version
10.0
Language
English
Product name
Finalist
Title
Finalist Compatibility Interface (CI) Migration Guide
Copyright
2023
First publish date
1998
ft:lastEdition
2024-05-15
ft:lastPublication
2024-05-15T00:18:43.325870

The CI Terminate (9) call is called PBFNTerminate (PBFNTERM) in the native interface. From zero (0) to ten (10) parameters can be passed to the PBFNTerminate call depending on the information you want returned. Full information for calling PBFNTerminate can be found in your Finalist Reference Guide in Chapter 1, Using the Finalist APIs.

If your application performs a PBFNInit call, even if the call fails (return code was -1), you should do a PBFNTerminate call. PBFNTerminate frees all storage that Finalist allocated. Failure to do this may result in a system ABEND due to un-freed storage.

The PBFNTerminate call can be a simple or complex API. If you wish to simply terminate Finalist and produce the reports requested during initialization, then call PBFNTerminate only NULL parameters.

If you wish additional information about the run, you can request summary information from the PBFNTerminate call. If you want details about all of the records that Finalist processed in this run, pass in the StatsDef structure (PBFNGSTS).

FINAL-RECORD-COUNT

PBFN-GSTS-TOTALPROCESSED

FINAL-ZIP-COUNT

PBFN-GSTS-TOTALZIPSASSIGNED

FINAL-LACS-COUNT

PBFN-GSTS-TOTALLACS

Another optional parameter is the 3553Def structure (PBFNNCAS). This structure returns the counts and information that allow you to create your own USPS Form 3553 (CASS Summary Report).

The other parameters allow you to receive *Link statistics.

PBFNTerminate only generates a 0 return code.