ArcObjects Library Reference (Location)

IGeocodeServer.GetLocatorProperties Method

Default properties for a locator.

[Visual Basic .NET]
Public Function GetLocatorProperties ( _
) As IPropertySet

[C#]
public IPropertySet GetLocatorProperties (
);

[C++]
HRESULT GetLocatorProperties(
  IPropertySet** props
);

[C++]

Parameters
props [out, retval]

  props is a parameter of type IPropertySet

Product Availability

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

Remarks

The GetLocatorProperties method returns a PropertySet containing all of the geocoding properties used by the GeocodeServer. To change the geocoding properties used when calling other methods on the IGeocodeServer interface, modify the properties in this PropertySet, then pass the PropertySet to the method you are calling using the propMods parameter on the method.

The following table describes all of the properties that might be contained in the PropertySet returned by the GetLocatorProperties method:

Name	Description	Values
EndOffset	The end offset used by the address locator.	A long integer value between 0 and 50
IntersectionConnectors	The intersection connectors used by the address locator.	A string value containing the space-delimited list of intersection connectors (e.g., "\| & @")
MatchIfScoresTie	Indicates if the GeocodeServer should match an addresses to a candidate if two or more candidates share the same best candidate score.	"TRUE" or "FALSE"
MinimumCandidateScore	The minimum candidate score used by the address locator.	A long integer value between 0 and 100
MinimumMatchScore	The minimum match score used by the address locator.	A long integer value between 0 and 100
ReverseDistance	The search distance to use to search for reference data features when reverse geocoding. The ReverseDistance value is specified in the reverse distance units used by the address locator.	A double floating-point value
ReverseDistanceUnits	The search distance units used by the address locator when reverse geocoding. Valid values include all of the enumeration constant names included in the esriUnits enumeration, without the "esri" prefix (e.g., "Meters").	A string representing the reverse geocoding distance units
SideOffset	The side offset used by the address locator. The SideOffset value is specified in the side offset units used by the address locator.	A double floating-point value
SideOffsetUnits	The side offset units used by the address locator. Valid values include all of the enumeration constant names included in the esriUnits enumeration, without the "esri" prefix (e.g., "Meters").	A string representing the side offset units
SpellingSensitivity	The spelling sensitivity used by the address locator.	A long integer value between 0 and 100
SuggestedBatchSize	The batch size to use when batch geocoding a table of addresses.	A long integer value
UICLSID	The Class ID of the LocatorUI object to use for the GeocodeServer's user interface in desktop applications.	A string value containing the CLSID

For more information on the properties listed above, please refer to the IGeocodingProperties interface.

IGeocodeServer.GetLocatorProperties Method

Product Availability

Remarks

See Also