C# SDK

◆ FindNearbyPoi() [2/2]

static int FindNearbyPoi ( out SError  Error,
out SPoi []  Pois,
ref Int32  ListSize,
Int32  CategoryNumber,
string  strCategoryName,
int  lX,
int  lY,
Int32  MaxTime 
)
inlinestatic

The function finds the defined number of nearest POIs around given position. The POIs may be from the original map POIs or they may be some custom POIs.

Parameters
ErrorAdditional error information returned from Drive.
PoisReturned array of SPoi classes containing information about the found POIs.
ListSizeNumber of POIs to return.
CategoryNumberCategory ID. If this value is filled with standard value, original POIs are found. Set to PoiService.USERDEFINE for custom POI. Possible values are enumerated in PoiService enum.
strCategoryNameCustom POI category name, if custom POI is searched.
lXX-coordinate of place, where to search.
lYY-coordinate of place, where to search.
MaxTimeMaximum time (in milliseconds) function can take. If MaxTime=0 function execution is not time limited.
Returns
1 if successful, other value otherwise.

Distance between taken position and POI is computed bee-line.

If dwCategory=PoiService.USERDEFINE it is necessary to define also strCategory. Otherwise category name is obtained from category ID.

X and Y coordinates are geographical longitude and latitude in degrees multiplied by 100000.


See Coordinates conversion section in TROUBLESHOOTING page.

Possible error codes returned from Drive are:

  • 0 - Function not succeeded.
  • 1 - Function succeeded.
  • 2 - Drive not succeeded.
  • 3 - Function reached timeout.

References SError.SizeOf().