ArcObjects Library Reference (Location)  

IAddressCandidates.FindAddressCandidates Method

Generates candidates for an address.

[Visual Basic .NET]
Public Function FindAddressCandidates ( _
    ByVal address As IPropertySet _
) As IArray
[C#]
public IArray FindAddressCandidates (
    IPropertySet address
);
[C++]
HRESULT FindAddressCandidates(
  IPropertySet* address,
  IArray** results
);
[C++]

Parameters

address [in]

  address is a parameter of type IPropertySet

results [out, retval]

  results is a parameter of type IArray

Product Availability

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

Remarks

The address parameter is a PropertySet that contains one property for each of the address fields defined by the address locator. You can use the IAddressInputs::AddressFields method to get the address fields for a address locator.

This method returns an Array of PropertySets. Each PropertySet in the Array has properties specified by the CandidateFields property.

See Also

IAddressCandidates Interface | IAddressCandidates Interface