You are here: Field Rules Reference > Field Rules Summary > SetAddr

SetAddr

Use this field level rule to store and retrieve subsequent lines of a multiple line address. This rule is useful if you are setting up an address which may have three or four lines of information. For instance, some addresses include a suite or apartment number. If one of the middle address lines is missing, the SetAddr rule will format the address to omit any white space or blank lines. This rule supports overflow.

The first time the rule is called, the format mask field must contain an F. This initializes the function and loads the address lines into an array. The system then returns the first line of the address data. Subsequent address variable fields should contain an N in the format mask field and return the next available non blank address line from the array.

The data element should contain the parameters necessary to get the multiple lines that make up the entire address record. Use of overflow with this rule only pertains to calls which have the format mask field set to F.

The data element has two parts, the first is the search criteria to get the extract record which contains the address information. The second part, separated from the first by a space, consists of offset,length pairs of address information.

When the address table is built, if one of the address lines consists of all blanks no entry is made in the address table. This lets you remove blank lines in an address.

Here are the optional format mask parameters you can use:

Parameter

Description

C

Converts to sentence style where the first character is capitalized and the remaining characters are lowercased.

S

Suppresses the state from the last address line.

U

Converts the data returned by the rule into uppercase.

See also