bool exportfunc CibOcrJobCreate(Handle *job); 

This method creates a job handle. The Job-handle is given to all  subsequent functions to ensure thread-security. It should be released again with CibOcrJobFree  after the task is completed. 

If no error occurs, the function result is TRUE, otherwise  FALSE. 

bool  exportfunc  CibOcrJobSetProperty  (Handle job, const char *name, const char *value); 

This function allows setting additional properties for a merge run. The names and values are expected to be UTF-8 encoded zero terminated strings. 

If no error occurs, the function result is TRUE, otherwise FALSE. 

Windows 

bool  exportfunc  CibOcrJobSetProperty W (Handle job, const  wchar *name, const  wchar  *value );  

This function allows setting additional properties for a merge run. The names and values are expected to be zero terminated wide strings.  

If no error occurs, the function result is TRUE, otherwise FALSE. 

bool  exportfunc  CibOcrJobGetProperty  (Handle *job, const char *name, const char *buffer, int size); 

This function returns the property values that are currently set into the specified buffer. The returned names and values are zero terminated strings in UTF-8 encoding. 

If no error occurs, the function result is TRUE, otherwise FALSE. 

Windows 

bool  exportfunc  CibOcrJobGetProperty W (Handle *job, const  wchar *name, const  wchar  *buffer, int size );  

This function returns the property values that are currently set into the specified buffer. The returned names and values are zero terminated wide strings. 

If no error occurs, the function result is TRUE, otherwise FALSE. 

(From CIB ocr version 2.3.2) 

bool exportfunc CibOcrJobGetProgress(Handle* job, char *buffer, size_t size); 

Gets percent of recognition progress. 

This function fills buffer by the string:  
<page_number> <page_count> <page_progress> 

If no error occurs, the function result is TRUE, otherwise FALSE. 

bool exportfunc CibOcrJobStart(Handle *job); 

Starts a CIB ocr-Job.  

If no error occurs, the function result is TRUE, otherwise FALSE. 

bool exportfunc CibOcrJobFree(Handle *job); 

This function frees the created CibOcrJobHandle and other resources allocated by CIB ocr. 

If no error occurs, the function result  is TRUE, otherwise FALSE. 

(From CIB ocr version 2.3.2 

bool exportfunc CibOcrJobCancel(Handle* job); 

This function stops recognition process. 

If no error occurs, the function result is TRUE, otherwise FALSE. 

bool CibOcrGetVersion(unsigned long * iVersion); 

This function provides access to the current CIB ocr version number as an integer.  

If no error occurs, the function result is TRUE, otherwise FALSE.  

bool exportfunc CibOcrGetVersionText(char *text, long *maxlength); 

This function provides access to the current CIB ocr version number as a string.  

If no error occurs function result is TRUE, otherwise FALSE.  

Windows 

bool exportfunc CibOcrGetVersionTextW(wchar *text, long *maxlength); 

This function provides access to the current CIB ocr version number as a string.  

If no error occurs function result is TRUE, otherwise FALSE.  

bool exportfunc CibOcrJobGetErrorText(Handle *job, char *text, long *maxlength); 

This function returns the error text that is output after executing a function. 

If no error occurs the function result is TRUE, otherwise FALSE. 

Windows 

bool exportfunc CibOcrJobGetErrorTextW(Handle *job, wchar *text, long *maxlength); 

This function returns the error text that is output after executing a function. 

If no error occurs the function result is TRUE, otherwise FALSE. 

bool exportfunc CibOcrJobGetError(Handle *job,  int *ErrorCode); 

This function gives access to the current error state of CIB ocr after executing various functions.  

If no error occurs, the function result is TRUE, otherwise FALSE. 

For all possible error-codes please see the appendix .