geomonitor_search_regions_by_name()

#include <geomonitor.h>
 

geomonitor_error_t geomonitor_search_regions_by_name(const char *name_mask, region_names_list_t *region_names_list)

Since:

BlackBerry 10.2.0

Arguments:

name_mask

The mask used to search the regions by name.

region_names_list

The list of region names found. This parameter must be initialized to NULL when passed to this function. The calling code takes ownership of the list and must release it using geomonitor_region_names_list_destroy().

Library:

libgeomonitor (For the qcc command, use the -l geomonitor option to link against this library)

Description:

This function returns a list of regions whose names include the substring name_mask. For example, if name_mask is "Toronto", then region_names_list will contain regions whose name includes that string (e.g., Toronto-Lakeshore, Toronto-Beaches, Toronto-North, etc.).

The number of regions returned is capped to a maximum number.

This function makes a service request that blocks until the service responds.

Returns:

GEOMONITOR_OK if successful, an error from geomonitor_error_t otherwise.