Address Match (Deprecated)

 

This macro has been deprecated. Please use Data.Finder Class and Data.Geocoder Class 

 

Summary

Creates a point geographic file from a set of records by locating each record based on its address.

 

Changes

Replaced by Locate View.

 

Syntax

error_msg = RunMacro("GISDK Address Match", string view_set, array fields, string street_layer, string output_database, string output_layer, string callback_flag)

 

Argument	Contents
view_set	The view and set to locate, separated by a vertical bar
fields	An array of strings containing the names of the address matching fields, as described below
street_layer	The name of the address-matchable street layer to search
output_database	The path and filename of the geographic file to create
output_layer	The name for the layer in the new geographic file
callback_flag	Any non-null value to query the user if multiple possible matches are detected, or null to prevent a query
rule_file	Optional country-specific rule file, or null to use the default American/Canadian rule file.

 

The fields array elements are as follows:

 

Element	Type	Contents
1	String	The name of the ID field, a numeric field that uniquely identifies each record in the view and set
2	String	The name of the address field, a string field containing the street address of each record: either a house number and a street name, or two street names separated by "and"
3	String	The name of the ZIP Code field, a numeric or string field containing the ZIP Code of each address. If this field is null, the City/State field must be included
4	String	The name of the City/State field, a string field containing the city and state of each address

 

Return Value

A string describing any error that occurred. If null, then the geographic file was created successfully.

 

Notes

• In Caliper Script, you must set the Geocode UI to be the alternate interface by calling SetAlternateInterface("geocode") before running this macro. When calling these macros from VBScript, add "geocode" after the macro name and before the first argument.

• For faster response, use compact (.cdf) Streets file for street_layer.

• The City/State field is only used if no ZIP Code field is included.

• If both a ZIP Code field and a City/State field are specified, the City/State field is ignored.

• The City/State field can be used only for addresses in the United States.

• The callback_flag argument must be null in VBScript.

• If rule_file is null, it is assumed the address has the format of an American or Canadian address, such as: "123 Main Street." Otherwise, you can specify the following rule files, which are shipped with the geocode UI and are located in the program folder:

•  

  caliper1.rul: U.S. addresses with hyphenated numbers

  str_num.rul: Street followed by number (e.g., "Via Nazionale 123")

  num_str.rul: Number followed by street, with no American abbreviations