CALLAREA Structure Definition - Finalist - 10.0

Finalist Guide

Product type
Software
Portfolio
Verify
Product family
Data Quality - Postals
Product
Finalist
Version
10.0
Language
English
Product name
Finalist
Title
Finalist Guide
Copyright
2023
First publish date
1984
Last updated
2024-05-15
Published on
2024-05-15T00:57:22.811031

The definition of the CALLAREA structure that is used to communicate with the AddrScan function is contained in the header file addrscan.h as shown below.

#define LN  70
	.
	.
#define NUM_INLINE     6
#define NUM_OUTLINE    4
#define NUM_OPTS       3
#define INDEX_SIZE     4
	.
	.
typedef struct {
    char  pInline[NUM_INLINE][LN];
    char  pOutline[NUM_OUTLINE][LN];
    char  urb[URB_SIZE];
    char  pAddrNdx1[INDEX_SIZE];
    char  pAddrNdx2[INDEX_SIZE];
    char  pAddrZip4[10];
    char  pAddrOpts[NUM_OPTS];
    char  pAddrTyps[6];          /* setting ‘A' to active advanced option.*/
    char  pAddrRord[9];
    short sAddrLnMx;
    char  University;
    char  Dormatory;
    char  pAddrAnch[8];
    /* Advanced options: */
    char  version[4];
    char  pCombineLines[6];
    char  pInputLineTypes[6];
    char  cNoMergeSecPMB;
    char  cSkipFirm;
    char  cSkipUrb;
    char  cSkipCSZ;
    char  cFirmIdx;
    char  cZipIdx;
    char  cUrbIdx;
    char  cFiller2[511];
} CALLAREA, *PCALLAREA;
Table 1. CALLAREA Member Descriptions
Member Name Length Description
char pInline[0] 70 Input address line 1.
char pInline[1] 70 Input address line 2.
char pInline[2] 70 Input address line 3.
char pInline[3] 70 Input address line 4.
char pInline[4] 70 Input address line 5.
char pInline[5] 70 Input address line 6.
char pOutline[0] 70 Returned address line 1.
char pOutline[1] 70 Returned address line 2.
char pOutline[2] 70 Returned city/state line.
char pOutline[3] 70 Returned firm line (if a firm was provided on input).
char urb 30 Returned urbanization line.
char pAddrNdx1 4 Returned index containing the line numbers of your original input address which correspond to the returned address lines.
char pAddrNdx2 4 Returned index containing the line numbers of the standardized input address which correspond to the returned address lines.
char pAddrZip4 10 Returned ZIP + 4 Code. Consists of the 5-digit ZIP Code, a hyphen, and the sector/segment.
char pAddrOpts 3 Returned Line Options (each 1 character long). Defines the option for selecting the line to be returned in output line 1 (pOutline[0]), the option for selecting the line to be returned in output line 2 (pOutline[1]), and the special option selector.
Note: If pAddrOpts contains HIGH-VALUES (0xFFFFFF), AddrScan terminates and frees all acquired storage.
char pAddrTyps 6 Returned line type codes that allow you to identify each of the standardized address lines.

pAddrTyps can also be used as an input field to alter AddrScan processing.

#
To prevent AddrScan from concatenating lines beginning with # to existing address lines, enter # in the pAddrTyps field.
P
To prevent AddrScan from recognizing periods as valid characters and to specify that periods should be removed before scanning address lines, enter a P in the pAddrTyps field.
D
To prevent AddrScan from concatenating a one-word line to an address line, enter a D in the pAddrTyps field. Note that, If an address line ends with a Unit Designator, a one-word line will always be concatenated.
A
To activate the advanced options of AddrScan, place an A in the pAddrTyps field.
Note: The values #, P, D, and A can populate any of the positions of the pAddrTyps field.
char pAddrRord 9 Returned Line Order. Defines the order in which standardized lines are returned.
short sAddrLnMx 2 This field is not used at this time.
char University 1 Set to "U" if university word found.
char Dormatory 1 Set to "D" if dormitory word found.
char pAddrAnch 8 Set to HIGH-VALUES (0xFF) prior to the first call.
char version[4] 4 AddrScan version
char pCombineLines[6] 6 Combined line index when occurs
char pInputLineTypes[6] 6 Input line types.
char cNoMergeSecPMB 1 Leave secondary or PMB line as is. Do not merge with any address line.
char cSkipFirm 1 Skip firm line processing.
char cSkipUrb 1 Skip return URB line processing.
char cSkipCSZ 1 Skip city, state and ZIP Code line processing.
char cFirmIdx 1 Firm index was found on input line.
char cZipIdx 1 ZIP Code index was found on input line.
char cUrbIdx 1 URB index was found on input line.
char unUsedLines 6 Identify unused lines.
char cFiller2[511] 505 Reserved for future use.