FindOptions Class
FindOptions Class
Contains search options used in the Find, FindAddress, FindByID, FindByProperty, FindNearby, FindNearRoute, and FindPolygon methods of the FindServiceSoap class. Specifies the range of results to return, the threshold score for the results, the search context, and a flag to identify which objects should be included in the results.
Public Class FindOptions Inherits System.Object
[C#]
public class FindOptions : System.Object
Public Properties
| Name | Description |
|---|---|
.gif) Range |
The range (FindRange object) of the full result set to return. The range identifies the first result that you want returned and the number of results to return. |
| ResultMask |
The mask, as a FindResultMask enumeration, that identifies which of the properties of the found location should be returned: address, map view, latitude and longitude coordinates, entity information, and Match Details information. Optional. |
| SearchContext |
The number representing the Entity.ID property of the geographic area to which the search should be limited. Overrides the UserInfoFindHeader.Context property. |
| ThresholdScore |
The score below which results should not be returned. The valid range is 0 through 1 (worst to best). |
Remarks
The FindOptions object is used in the FindSpecification.Options, FindAddressSpecification.Options, FindByIDSpecification.Options, FindByPropertySpecification.Options, FindNearbySpecification.Options, and FindNearRouteSpecification.Options properties, which are passed in the specification parameter of the Find, FindAddress, FindByID, FindByProperty, FindNearby, FindNearRoute, and FindPolygon methods.
To set options for the FindServiceSoap.GetLocationInfo method, use the GetInfoOptions class.
See Also
FindServiceSoap Class | FindRange Class | FindResultMask Enumeration | Entity.ID Property | UserInfoFindHeader.Context Property