ESRI.ArcGIS.ADF.Web.DataSources.IMS
FindAddressCandidates(Generic List,Boolean,Boolean,Generic Dictionary) Method
See Also 
ESRI.ArcGIS.ADF.Web.DataSources.IMS Namespace > GeocodeFunctionality Class > FindAddressCandidates Method : FindAddressCandidates(Generic List,Boolean,Boolean,Generic Dictionary) Method




address
Address to geocode, in the form of a list of address values.
includeOIDField
Whether to include the object ID field in the results.
includeGeometryField
Whether to include a field with geometry (points)of locations in the results.
propMods
A set of locator properties that contain settings for geocoding.
Finds a set of locations that are candidates to match the input address.

Syntax

Visual Basic (Declaration) 
Public Overloads Function FindAddressCandidates( _
   ByVal address As List(Of AddressValue), _
   ByVal includeOIDField As Boolean, _
   ByVal includeGeometryField As Boolean, _
   ByVal propMods As Dictionary(Of String, Object) _
) As DataTable
Visual Basic (Usage)Copy Code
Dim instance As GeocodeFunctionality
Dim address As List(Of AddressValue)
Dim includeOIDField As Boolean
Dim includeGeometryField As Boolean
Dim propMods As Dictionary(Of String, Object)
Dim value As DataTable
 
value = instance.FindAddressCandidates(address, includeOIDField, includeGeometryField, propMods)
C# 
public DataTable FindAddressCandidates( 
   List<AddressValue> address,
   bool includeOIDField,
   bool includeGeometryField,
   Dictionary<string, object> propMods
)

Parameters

address
Address to geocode, in the form of a list of address values.
includeOIDField
Whether to include the object ID field in the results.
includeGeometryField
Whether to include a field with geometry (points)of locations in the results.
propMods
A set of locator properties that contain settings for geocoding.

Return Value

Table of candidates for matching the input address.

Remarks

When geocoding, many locations may partially match the input address. This method finds locations whose geocode score is at least the MinCandidateScore. Since the MinCandidateScore is typically low, this method may return a large number of candidates.

See Also

© 2010 All Rights Reserved.