geo_search_reply_get_description()

Retrieve the location description of the result at the current index in the reply.

Synopsis:

#include <geo_search.h>
geo_search_error_t geo_search_reply_get_description(geo_search_reply_t *reply, const char **description)

Since:

BlackBerry 10.0.0

Arguments:

reply

The search reply.

description

The resultant description (UTF-8 string).

Library:

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

Description:

The description may contain ancillary information relevant to the location.

See geo_search_reply_get_name() for an example of usage.

Returns:

GEO_SEARCH_OK if successful. On error, returns GEO_SEARCH_ERROR_REPLY.

Parent topic: Functions in geo_search.h