Share via

FindNearbySpecification Class

  • Article

FindNearbySpecification Class

Contains the search specification used in the FindServiceSoap.FindNearby method. Specifies the search area, the entity type, properties, and values to match, the search options to use, and the data source from which to get results.


Public Class FindNearbySpecification Inherits System.Object


[C#]

public class FindNearbySpecification : System.Object

Public Properties

Name Description
public propertyDataSourceName

A string representing the name of the data source (DataSource.Name property) in which to search for entities.
public propertyDistance

The distance from the LatLong property in which to search, in distance units (DistanceUnit enumeration) as specified in the UserInfoFindHeader.DefaultDistanceUnit property.
public propertyFilter

The filter (FindFilter object) to apply to the results; that is, the specific entity type, properties, and values that the returned results must match.
public propertyLatLong

The latitude and longitude coordinate (LatLong object) for the point around which the search is made.
public propertyOptions

The search options (FindOptions object), which may include the range of results and a flag to identify which objects are desired in the returned results.

Remarks

  • The FindNearbySpecification class is used as input to the specification parameter of the FindServiceSoap.FindNearby method.

  • For the FindNearbySpecification object to be valid, it must contain DataSourceName, Distance, Filter, and LatLong properties. If the Options property is null, default options are used.

  • The FindServiceSoap.FindNearby method is valid only with data sources that have a CanFindNearby capability (DataSourceCapability enumeration). This includes several MapPoint Web Service point-of-interest data sources, as well as your own data source if you have uploaded location data to it using the MapPoint Web Service Customer Services site (https://mappoint-css.live.com/CSCV3/).

  • For more information about MapPoint Web Service data sources, see MapPoint Web Service Data Sources and Capabilities.

  • To retrieve a list of data sources and their capabilities, use the CommonServiceSoap.GetDataSourceInfo method.

  • For information about using your own data with MapPoint Web Service, see the Help topic Using the MapPoint Web Service Customer Services site in the MapPoint Web Service Customer Services site (https://mappoint-css.live.com/CSCV3/).

  • For information about becoming a customer, visit the MapPoint Web Service Web site.

See Also

  DataSource.Name Property   |   DistanceUnit Enumeration   |   UserInfoHeader.DefaultDistanceUnit Property   |   FindFilter Class   |   LatLong Class   |   FindOptions Class