Gets fields contained in a list of candidates returned from geocoding an address using the FindAddressCandidates method.
GetCandidateFields(PropertySet PropMods)
|
Parameter |
Description |
|
PropMods
|
Modifications to the geocode service (locator) properties. |
Return Value
A Fields object containing one of more Field objects, each representing information about a match candidate.
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...).
|
Examples