geomonitor_error

Geomonitor error types.

Synopsis:

#include <geomonitor.h>

typedef enum {
      GEOMONITOR_OK = 0   
      GEOMONITOR_INVALID_IPARAM = 0x10   
      GEOMONITOR_INVALID_IPARAM_NULL_HANDLE = 0x11   
      GEOMONITOR_INVALID_IPARAM_INITIALIZED_HANDLE = 0x12   
      GEOMONITOR_INVALID_IPARAM_NULL_VALUE = 0x13   
      GEOMONITOR_INVALID_IPARAM_STRING_TOO_LONG = 0x14   
      GEOMONITOR_INVALID_OPARAM_NULL_REFERENCE = 0x15   
      GEOMONITOR_INVALID_IPARAM_INDEX = 0x16   
      GEOMONITOR_INVALID_IPARAM_SHAPE = 0x17   
      GEOMONITOR_INVALID_IPARAM_COORDS = 0x18   
      GEOMONITOR_INVALID_IPARAM_RADIUS = 0x19   
      GEOMONITOR_INVALID_IPARAM_EVENT_TYPE = 0x1A   
      GEOMONITOR_INVALID_IPARAM_EXPIRATION = 0x1B   
      GEOMONITOR_MEMORY_ALLOCATION_ERROR = 0x1C   
      GEOMONITOR_INVALID_IPARAM_MONITORING_MODE = 0x1D   
      GEOMONITOR_INVALID_APPLICATION_NAME = 0x20   
      GEOMONITOR_INTERNAL_API_ERROR = 0x21   
      GEOMONITOR_INVALID_SERVICE_REPLY = 0x22   
      GEOMONITOR_INTERNAL_SERVICE_ERROR = 0x23   
      GEOMONITOR_ERROR_NO_SERVICE_CONNECTION = 0x24   
      GEOMONITOR_LOCATION_SERVICES_DISABLED = 0x25   
      GEOMONITOR_CURRENT_LOCATION_NOT_AVAILABLE = 0x26   
      GEOMONITOR_ERROR_NO_PERMISSION = 0x27   
      GEOMONITOR_REGION_ERROR = 0x100   
      GEOMONITOR_REGION_ALREADY_ADDED = 0x101   
      GEOMONITOR_REGION_NOT_FOUND = 0x102   
      GEOMONITOR_REGION_INVALID_SHAPE_TYPE = 0x103   
      GEOMONITOR_REGION_EMPTY_NAME = 0x104   
      GEOMONITOR_ERROR_NOTIFICATIONS_RECEIVER_NOT_ADDED = 0x105   
      GEOMONITOR_NOTIFICATIONS_ERROR = 0x200   
      GEOMONITOR_NOTIFICATIONS_ALREADY_REQUESTED = 0x201   
      GEOMONITOR_NOTIFICATIONS_NOT_REQUESTED = 0x202   
      GEOMONITOR_NOTIFICATIONS_RECEIVER_NOT_FOUND = 0x203   
      GEOMONITOR_INVALID_OFFLINE_NOTIFICATION_TARGET = 0x204   
} geomonitor_error_t;

Since:

BlackBerry 10.2.0

Data:

GEOMONITOR_OK: Correct result for an operation.

GEOMONITOR_INVALID_IPARAM: Invalid parameters were passed to the function.

GEOMONITOR_INVALID_IPARAM_NULL_HANDLE: A NULL-referenced handle was passed to the function, which expects a valid handle initialized to NULL.

GEOMONITOR_INVALID_IPARAM_INITIALIZED_HANDLE: An already initialized handle was passed to the function, which expects a NULL-referenced handle.

GEOMONITOR_INVALID_IPARAM_NULL_VALUE: A NULL referenced parameter was passed to the function, which expects a valid pointer to perform an operation.

GEOMONITOR_INVALID_IPARAM_STRING_TOO_LONG: A string type input parameter passed to the function is too long.

GEOMONITOR_INVALID_OPARAM_NULL_REFERENCE: A NULL referenced output parameter was passed to the function, which expects a valid pointer.

GEOMONITOR_INVALID_IPARAM_INDEX: An invalid index value (e.g., out of bounds) was passed to the function.

GEOMONITOR_INVALID_IPARAM_SHAPE: An invalid or unsupported shape type was passed to the function.

GEOMONITOR_INVALID_IPARAM_COORDS: One or more invalid geocordinates were passed to the function.

GEOMONITOR_INVALID_IPARAM_RADIUS: An invalid radius value was passed to the function.; The radius must be greater than 0.

GEOMONITOR_INVALID_IPARAM_EVENT_TYPE: An invalid geomonitor event type was passed to the function.

GEOMONITOR_INVALID_IPARAM_EXPIRATION: An invalid expiration time was passed to the function.

GEOMONITOR_MEMORY_ALLOCATION_ERROR: Not enough memory to perform operation.

GEOMONITOR_INVALID_IPARAM_MONITORING_MODE: An invalid geomonitor monitoring mode was passed to the function.

GEOMONITOR_INVALID_APPLICATION_NAME: Application name cannot be defined.

GEOMONITOR_INTERNAL_API_ERROR: Internal geomonitor API error.

GEOMONITOR_INVALID_SERVICE_REPLY: Invalid geomonitor service reply.

GEOMONITOR_INTERNAL_SERVICE_ERROR: Internal geomonitor service service error.

GEOMONITOR_ERROR_NO_SERVICE_CONNECTION: Geomonitor service is not available.

GEOMONITOR_LOCATION_SERVICES_DISABLED: Location services are disabled.

GEOMONITOR_CURRENT_LOCATION_NOT_AVAILABLE: Current location is not available.

GEOMONITOR_ERROR_NO_PERMISSION: Calling code does not have permissions to access geomonitor service.

GEOMONITOR_REGION_ERROR: Region processing error.

GEOMONITOR_REGION_ALREADY_ADDED: Region with the given name was already added by the application.

GEOMONITOR_REGION_NOT_FOUND: Region with the given name was not found.

GEOMONITOR_REGION_INVALID_SHAPE_TYPE: Region shape type is not set or is different from the requested type.; This error is returned if geomonitor_region_get_shape_type() is called for the region that has a shape other than circle.

GEOMONITOR_REGION_EMPTY_NAME: Empty name (0 length string) for the region is not allowed.

GEOMONITOR_ERROR_NOTIFICATIONS_RECEIVER_NOT_ADDED: Region cannot be added in the transient monitoring mode since the calling application does not have an initialized geomonitor service handle.

GEOMONITOR_NOTIFICATIONS_ERROR: Notification processing error.

GEOMONITOR_NOTIFICATIONS_ALREADY_REQUESTED: Client already requested notification via the given geomonitor service handle.

GEOMONITOR_NOTIFICATIONS_NOT_REQUESTED: Client has not requested any notification via the given geomonitor service handle.

GEOMONITOR_NOTIFICATIONS_RECEIVER_NOT_FOUND: An application that requested the notification is closed or the geomonitor service handle is closed.

GEOMONITOR_INVALID_OFFLINE_NOTIFICATION_TARGET: Offline notification invoke target is not valid or is used to invoke a different application.

Library:

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

Description:

This enumeration defines the errors that can be returned by geomonitor functions.