C++ SDK

◆ MakeUserPoiVisible()

static int CApplicationAPI::MakeUserPoiVisible ( LpError  lpError,
DWORD  dwCategory,
LPCTSTR  lpszCategory,
BOOL  bShow,
DWORD  dwMaxTime = DEFAULT_MAX_TIME 
)
static

The function shows or hides POI category in POI category list.

Parameters
lpErrorAdditional error information returned from Drive.
dwCategoryCategory ID. Possible values are enumerated in PoiService enum.
lpszCategoryCustom category name to show/hide.
bShowFlag determinig whether MakeUserPoiVisible shows or hides category. If bShow=true category will be shown if bShow=false category will be hidden.
dwMaxTimeMaximum time (in milliseconds) function can take. If dwMaxTime=0 function execution is not time limited.
Returns
1 if successful, other value otherwise.

If MakeUserPoiVisible hides custom category the category does not occur in category list.

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

Possible error codes returned from Drive are:

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