2.1.8   Get the favorites list

The .in file

Attributes in [Head] section:

Type: 8
Allowed Mode: 0 (try once), 1 (try until success), 2 (loop)
Allowed Blocking: 0 (non blocking), 1 (blocking)

Attributes in [FavoriteList] section:

• SearchAddress: Output the location as an address in the .out file. 0=disabled, 1=enabled. This attribute is optional. Default is 0.

Note: If SearchAddress is enabled, the application tries to find the correct addresses for all favorites. The addresses are written in the .out file as FavoriteLocationAddress attributes. If SearchAddress is disabled, the value of FavoriteLocationAddress attributes will look like ",,,,".
Warning: Finding the address from mercator coordinates or geodez-tupels takes a very long time. Therefore the application won't respond during the search!

Sample .in file: Get a list of all favorites

[Head] Type=8 Mode=0 Blocking=0 [FavoriteList] SearchAddress=0

The .out file

Attributes in [FavoriteList] section:

• NumberOfFavorites: Number of favorites in the favorite list
• SearchAddress: The SearchAddress attribute given in the .in file
• A separate section is created for each favorite. The section names are sequentially named starting with 1, e.g. favorite one's section is named [Favorite_1] ....
  Attributes in [Favorite_i] section:
  • FavoriteID: The unique identifier for this favorite
  • FavoriteType: Type of the favorite

  FavoriteType	Description
  1	GPS position
  2	click point
  3	address
  4	homebase
  5	previous destination
  6	favorite
  7	Search for Next
  8	point of interest
  9	destination defined via command line
  10	destination defined via remote control

  • FavoriteTypeDesc: A textual description of FavoriteType
  • FavoriteCaption: The caption of the favorite, which is displayed in the application
  • FavoriteLocationMercator: The mercator coordinates of the favorite
  • FavoriteLocationGeodecimal: Geographical coordinates of the favorite
  • FavoriteLocationAddress: The address of the favorite
  The output is given as a formatted string like the following:
  D,76131,Karlsruhe,Tullastrasse,1-11|2-20
  The housenumber will be given as ranges separated by the pipe '|' symbol. A range of 0-0 means no housenumber found for this side of the segment. The different ranges will always be sorted from lower to upper.

Sample .out file: There are currently 2 favorites: Number 1 was added via remote control interface, number 2 was added from a previous destination

[Head] Type=8 TypeDesc=get favorite list Mode=0 ModeDesc=try once Blocking=0 BlockingDesc=not blocking Timestamp=677255750 Id=677255546 Result=2 ResultDesc=success and request deleted ExecuteDuration=156 [FavoriteList] NumberOfFavorites=2 SearchAddress=0 [Favorite_1] FavoriteID=677202297 FavoriteType=10 FavoriteTypeDesc=remote control FavoriteCaption=Remote Control Favorite (Address) FavoriteLocationMercator=937575,6269540 FavoriteLocationGeodecimal=+8.431815,+49.010029 FavoriteLocationAddress=,,,, [Favorite_2] FavoriteID=677202298 FavoriteType=5 FavoriteTypeDesc=previous destination FavoriteCaption=Bahnhof Bad Schwartau FavoriteLocationMercator=1189670,7146825 FavoriteLocationGeodecimal=+10.698959,+53.919002 FavoriteLocationAddress=,,,,