RecognizerError.h File Reference

#include "Export.h"

Go to the source code of this file.

Typedefs
typedef MB_EXPORTED_TYPE enum MBRecognizerErrorStatus	MBRecognizerErrorStatus
	Typedef for RecognizerErrorStatus enum.

Enumerations
enum	MBRecognizerErrorStatus {   MB_RECOGNIZER_ERROR_STATUS_SUCCESS = 0 , MB_RECOGNIZER_ERROR_STATUS_FAIL , MB_RECOGNIZER_ERROR_STATUS_MALLOC_FAIL , MB_RECOGNIZER_ERROR_STATUS_INVALID_LICENSE_KEY ,   MB_RECOGNIZER_ERROR_STATUS_NOT_SUPPORTED , MB_RECOGNIZER_ERROR_STATUS_RECOGNIZER_IN_USE , MB_RECOGNIZER_ERROR_STATUS_INVALID_SETTINGS , MB_RECOGNIZER_ERROR_STATUS_INVALID_ARGUMENT ,   MB_RECOGNIZER_ERROR_STATUS_NETWORK_ERROR , MB_RECOGNIZER_ERROR_STATUS_REMOTE_LOCK }
	Enumeration of all possible error statuses. More...

Functions
MB_API char const *MB_CALL	recognizerErrorToString (MBRecognizerErrorStatus errorStatus)

Detailed Description

Copyright (c)2015 MicroBlink Ltd. All rights reserved.

ANY UNAUTHORIZED USE OR SALE, DUPLICATION, OR DISTRIBUTION OF THIS PROGRAM OR ANY OF ITS PARTS, IN SOURCE OR BINARY FORMS, WITH OR WITHOUT MODIFICATION, WITH THE PURPOSE OF ACQUIRING UNLAWFUL MATERIAL OR ANY OTHER BENEFIT IS PROHIBITED! THIS PROGRAM IS PROTECTED BY COPYRIGHT LAWS AND YOU MAY NOT REVERSE ENGINEER, DECOMPILE, OR DISASSEMBLE IT.

Enumeration Type Documentation

MBRecognizerErrorStatus

enum MBRecognizerErrorStatus

Enumeration of all possible error statuses.

Enumerator
MB_RECOGNIZER_ERROR_STATUS_SUCCESS	Operation was successfully completed
MB_RECOGNIZER_ERROR_STATUS_FAIL	Operation failed
MB_RECOGNIZER_ERROR_STATUS_MALLOC_FAIL	Failed to allocate memory
MB_RECOGNIZER_ERROR_STATUS_INVALID_LICENSE_KEY	Invalid or expired license key was provided
MB_RECOGNIZER_ERROR_STATUS_NOT_SUPPORTED	Operation is not supported
MB_RECOGNIZER_ERROR_STATUS_RECOGNIZER_IN_USE	Specified recognizer is in use and cannot be modified.
MB_RECOGNIZER_ERROR_STATUS_INVALID_SETTINGS	Invalid settings were provided
MB_RECOGNIZER_ERROR_STATUS_INVALID_ARGUMENT	Invalid argument was provided to the function
MB_RECOGNIZER_ERROR_STATUS_NETWORK_ERROR	There has been a network error while validating the license key
MB_RECOGNIZER_ERROR_STATUS_REMOTE_LOCK	Given license key has been remotely locked

Function Documentation

recognizerErrorToString()

MB_API char const *MB_CALL recognizerErrorToString

(

MBRecognizerErrorStatus

errorStatus

)

Helper method for fetching string representation of the error status. Usually used in debugging.

Parameters

errorStatus

status for which the string representation is required

Returns

null terminated string for required status