ArcObjects Library Reference (Location)

IAddressCandidates Interface

Provides access to members for generating candidates for an address. Note: the IAddressCandidates interface has been superseded byIAddressCandidates2. Please consider using the more recent version.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

When To Use

Use the IAddressCandidates interface to find and inspect candidates for a single address.

Members

		Description
	CandidateFields	Fields contained in a list of candidates.
	FindAddressCandidates	Generates candidates for an address.

CoClasses that implement IAddressCandidates

CoClasses and Classes	Description
AGSAddressLocator	A locator adaptor for the GeocodeServer proxies.
ESRIFDOAddressLocator	An address locator that uses the Esri geocoding engine developed prior to ArcGIS version 10.0.
ESRIGen2AddressLocator	An address locator that uses the Esri geocoding engine introduced in ArcGIS version 10.0.
RSLocator	An address locator that uses the Esri RouteServer geocoding engine.
StreetMapAddressLocator	A locator that uses the Esri geocoding engine and StreetMap reference data sources.

Remarks

Address candidates are defined by a number of candidate fields. Each candidate field describes some part of the address information for the match candidate. An address locator uses these candidate fields to determine how well a candidate matches an address. The candidate fields that are generated by the address locator styles provided with ArcGIS are described below:

From - The beginning of the address range.
FromLeft - The beginning of the address range on the left side of the street.
FromRight - The beginning of the address range on the right side of the street.
HouseNum - The street number of the address.
KeyField - The single field describing the address.
LeftCity - The city on the left side of the street.
LeftZip - The ZIP code on the left side of the street.
LeftZone - The zone on the left side of the street.
PreDir - The street prefix direction.
PreType - The street prefix type.
RightCity - The city on the right side of the street.
RightZip - The ZIP code on the right side of the street.
RightZone - The zone on the right side of the street.
Score - A score between 0 and 100 that indicates how well a candidate matches an address. A score of 100 represents an exact match.
Shape - The geometry of the match candidate.
Side - For geocoding services that can match addresses to a particular side of a street, the side of the street on which the address matches the candidate. A value of "L" indicates the left side of the street, and a value of "R" indicates the left side of the street.
State - The state.
StreetName - The street name.
StreetType - The street type.
SufDir - The street suffix direction.
To - The end of the address range.
ToLeft - The end of the address range on the left side of the street.
ToRight - The end of the address range on the right side of the street.
Zip - The ZIP code.
Zip4 - The last four digits of a ZIP+4 code.
Zip4Low - The lowest four digit code of a ZIP+4 range.
Zip4High - The highest four digit code of a ZIP+4 range.
Zone - The zone.