IAddressCandidates2.FindMatchingAddressCandidates Method

Generates candidates for an address, including only matching ones.

[Visual Basic .NET]
Public Function FindMatchingAddressCandidates ( _
    ByVal address As IPropertySet _
) As IArray

[C#]
public IArray FindMatchingAddressCandidates (
    IPropertySet address
);

[C++]
HRESULT FindMatchingAddressCandidates(
  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

Remarks

The FindMatchingAddressCandidates method is similar to the FindAddressCandidates method, with the exception that FindMatchingAddressCandidates returns only candidates with scores greater than or equal to the minimum match score for the locator.

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

IAddressCandidates2 Interface | IAddressCandidates Interface