C++ SDK

◆ ShowRectangleOnMap()

static int CApplicationAPI::ShowRectangleOnMap ( LpError  lpError,
LONGRECT  rcRect,
BOOL  bShowApplication,
DWORD  dwMaxTime = DEFAULT_MAX_TIME 
)
static

The function shows specific piece of map on the BrowseMap according to your selected coordinates of top left and bottom right corner.

Parameters
lpErrorAdditional error information returned from Drive.
rcRectRectangle to show on the BrowseMap.
dwMaxTimeMaximum time (in milliseconds) function can take. If dwMaxTime=0 function execution is not time limited.
bShowApplicationFlag determining whether Drive should be brought to foreground automatically.
true - Drive will be brought to foreground.
false - Drive will stay in background. return 1 if successful, other value otherwise.

Zoom will be adjusted so that entire rectangle will be shown.

BrowseMap is map shown on after clicking Browse Map menu button. BrowseMap allows browse the loaded maps and change zoom.

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.