progress_api.c File Reference

API function implementations. More...

#include "fret.h"
#include "requesthandler.h"

Include dependency graph for progress_api.c:

Functions
bool	fret_setProgressCallback (fret_sendProgressFunc pCallback)
	Passes a pointer to a callback function which is used to notify the client about the progress of the current operation.
bool	fret_cancelScan (void)
	Passes a pointer to a callback function which is used to notify the client about the progress of the current operation.

---

Detailed Description

API function implementations.

---

Function Documentation

bool fret_cancelScan (  void   )

Passes a pointer to a callback function which is used to notify the client about the progress of the current operation. Passes a pointer to a callback function, which is provided by the client, that is used by the library to send updates on the progress of the current scan. The current scan must have been initiated using a call to fret_runScan(). fret_runScan is not atomic i.e. Grams that have already been generated will remain after the scans are cancelled. Returns: true if current scan(s) were stopped and cancelled. false if the function could not be registered. Query cause with fret_getError(). See also: fret_getError fret_runScan

bool fret_setProgressCallback (  fret_sendProgressFunc  pCallback  )

Passes a pointer to a callback function which is used to notify the client about the progress of the current operation. Passes a pointer to a callback function, which is provided by the client, that is used by the library to send updates on the progress of the current scan. Parameters: pCallback  is a pointer to the callback function. Returns: true if function is registered correctly. false if the function could not be registered. Query cause with fret_getError(). See also: fret_getError fret_sendProgressFunc

---