Fields contained in the results of a geocode operation using the GeocodeAddress() and GeocodeAddresses() methods.
GetResultFields(PropertySet PropMods)
|
Parameter |
Description |
|
PropMods |
Modifications to the geocode service properties.
|
Return Value
A Fields object containing one of more Field objects. Each Field represents information about a geocoded address. Both intersection and non-intersection addresses will return the same result fields.
Remarks
The fields returned from this method include
the match fields defined for the specific address style for the geocode
service and a set of common fields available for most geocode services.
The address style fields are specific to
the style being used by the geocode service and may differ from style
to style. The common fields will remain consistent.
If enabled on a geocode service, they can include
the fields listed in the table below. Note that
most address styles will return the Shape, Status, and Score fields at
a minimum.
|
Field name |
Description |
|
Pct_along |
For geocode services that use line geometry as reference data (e.g. streets), this value represents the percentage along the matched feature at which the matched address is located.
|
|
Ref_ID |
The ObjectID of the matched feature.
|
|
Score |
A number between 0 and 100 indicating the score of the matched feature. A score of 100 represents an exact match.
|
|
Shape |
Geometry of the matched address.
|
|
Side |
For geocode services that can match addresses to a particular side of a street, this value represents the side of the street on which the address matches the matched feature. A value of "L" indicates the left side of the street, and a value of "R" indicates the right side of the street.
|
|
Stan_addr |
The standardized address.
|
|
Status |
A string value that indicates whether the address was matched ("M"), unmatched ("U"), or had two or more candidates tied with the best score ("T").
|
|
X |
The X coordinate of the matched address.
|
|
Y |
The Y coordinate of the matched address.
|
|
Match_addr
|
The address matched in the reference data.
|
|
ResultID |
Unique integer id of the matched feature assigned by the geocode service. Included in the record set returned from a call to the GeocodeAddresses() method. The first row (match) returned is assigned a value of 0 and the value for each subsequent row is incremented by 1 (e.g. 0,1,2...).
|
The PropMods parameter is a PropertySet containing
the geocode service properties used when locating an address. These
properties are returned by the GetLocatorProperties() method. Only
a few locator properties will modify the result fields collection. If
a property is true, the result fields will be included in a geocode result.
If false, the fields will not be included. The
locator properties and cooresponding result fields are listed below:
|
Locator property name |
Result field(s) |
|
WriteXYCoordFields |
X, Y
|
|
WriteStandardizedAddressField |
Stan_addr
|
|
WriteReferenceIDField |
Ref_ID
|
|
WritePercentAlongField |
Pct_along
|
To modify locator properties, modify the properties
in the PropertySet returned by the GetLocatorProperties() method and pass
the modified PropertySet as the PropMods parameter. The PropertySet only
needs to contain properties that are different than the default properties
for the geocode service. If you do not need to
modify any of the default properties returned used by the geocode service,
the PropMods parameter can be null or you can pass the unmodified PropertySet
returned by the GetLocatorProperties() method.
Examples