init_api.c File Reference

API function implementations. More...

#include "fret.h"
#include "common.h"

Include dependency graph for init_api.c:

Enumerations
enum
Functions
bool	fret_init (void)
bool	fret_deinit (void)
bool	fret_getError (FretError *const pError)
bool	fret_setOptions (const ScanOptions *const pOpts)

---

Detailed Description

API function implementations.

---

Enumeration Type Documentation

anonymous enum

Default minimum length of a detected Gram.

---

Function Documentation

bool fret_deinit (  void   )

De-initializes the FRET library and deallocates internal resources. Returns: true if all resources were freed correctly. false if resource deallocation failed. The failure mode can be retrieved using the function fret_getError(). See also: fret_getError

bool fret_getError (  FretError *const   pError  )

Get an error code describing the cause of the last known error. Parameters: pError  is a pointer to a FretError variable that will store the error identifier. Returns: true if there is an error to report. false if there is no known error to report. It may be that another API function was called and reset the state. See also: FretError

bool fret_init (  void   )

Initialize the FRET library and allocate internal resources. Returns: true if library can be used. false if resource allocation failed. the failure mode can be retrieved using the function fret_getError(). See also: fret_getError

bool fret_setOptions (  const ScanOptions *const   pOpts  )

Passes client specified options, which affecting scanning behaviour, to the library. Returns: true if there is no error to report. false if an incorrect option is passed to the library. The failure mode can be retrieved using the function fret_getError(). See also: ScanOptions fret_getError

---