2.1.3   Add a stop-off point to the favorites list

The .in file

Attributes in [Head] section:

Type: 3
Allowed Mode: 0 (try once)
Allowed Blocking: 0 (non blocking)

Attributes in [StopOffPoint] section:

• Location: The location of the stop-off point to add. Location can be entered in 3 formats:
  • Address: country code,zip code,town,street,house number
    e.g. D,76131,Karlsruhe,Tullastrasse,1
  • Mercator coordinates: xxxxxx,yyyyyyy
    e.g. 951215,6261940
  • Geodez-Tupel: x.xxxxxxx,y.yyyyyyyy
    e.g. 8.5545,48.9652
• Caption: The caption which appears in the favorites list
• 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 address, if Location is given as mercator coordinates or geodez-tupel. The address is written in the .out file as Location_Address attribute. If SearchAddress is disabled, the value of Location_Address-attribute 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: This request adds a stop-off point by using an address

[Head] Type=3 Mode=0 Blocking=0 [StopOffPoint] Location=D,76131,Karlsruhe,Tullastrasse,1 Caption=Remote Control Favorite (Address)

The .out file

Attributes in [StopOffPoint] section:

• Location: The location attribute given in the .in file
• Caption: The caption attribute given in the .in file
• SearchAddress: The SearchAddress attribute given in the .in file
• StopOffPointResult: Result code

  StopOffPointResult	Description
  -4	Stop-off point was not added; the favorites list is full
  -3	Stop-off point was not added; the location is ambiguous
  -2	Stop-off point was not added; the location does not exist on the map
  -1	Stop-off point was not added; the location syntax is invalid
  1	Stop-off point was added successfully

• StopOffPointResultDesc: A textual description of StopOffPointResult
• Location_Mercator: Mercator coordinates of the added stop-off point
• Location_Geodecimal: Geographical coordinates of the added stop-off point
• Location_Address: Address of the added stop-off point
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: The stop-off point was added successfully

[Head] Type=3 TypeDesc=add stop-off point to favorites Mode=0 ModeDesc=try once Blocking=0 BlockingDesc=not blocking Timestamp=281431000 Id=281430968 Result=2 ResultDesc=success and request deleted [StopOffPoint] Location=D,76131,Karlsruhe,Tullastrasse,1 Caption=Remote Control Favorite (Address) SearchAddress=0 StopOffPointResult=1 StopOffPointResultDesc=stop-off point added Location_Mercator=937575,6269540 Location_Geodecimal=+8.431815,+49.010029 Location_Address=D,76131,Karlsruhe,Tullastrasse,1