cddb.h File Reference

#include <cddb/version.h>
#include <cddb/cddb_config.h>
#include <cddb/cddb_error.h>
#include <cddb/cddb_track.h>
#include <cddb/cddb_disc.h>
#include <cddb/cddb_site.h>
#include <cddb/cddb_conn.h>
#include <cddb/cddb_cmd.h>
#include <cddb/cddb_log.h>

Go to the source code of this file.

Defines
#define	CDDB_H   1
#define	BIT(n)   (1 << n)
Enumerations
enum	cddb_flag_t { CDDB_F_EMPTY_STR = BIT(0), CDDB_F_NO_TRACK_ARTIST = BIT(1) }
	An enumeration of flags that influence the behaviour of the library. More...
Functions
void	libcddb_init (void)
	Initializes the library.
void	libcddb_shutdown (void)
	Frees up any global (cross connection) resources.
void	libcddb_set_flags (unsigned int flags)
	Set one or more flags that influence the library behvaiour.
void	libcddb_reset_flags (unsigned int flags)
	Reset one or more flags that influence the library behvaiour.

---

Define Documentation

#define BIT (  n   )     (1 << n)

#define CDDB_H   1

---

Enumeration Type Documentation

enum cddb_flag_t

An enumeration of flags that influence the behaviour of the library. You can set or reset these flags using the libcddb_set_flags and libcddb_reset_flags functions. Enumerator: CDDB_F_EMPTY_STR  never return NULL pointer strings (default), return an empty string instead CDDB_F_NO_TRACK_ARTIST  do not return the disc artist as the track artist (default), return NULL instead

---

Function Documentation

void libcddb_init (  void   )

Initializes the library. This is used to setup any globally used variables. The first time you create a new CDDB connection structure the library will automatically initialize itself. So, there is no need to explicitly call this function.

void libcddb_reset_flags (  unsigned int  flags  )

Reset one or more flags that influence the library behvaiour. Parameters: flags  A bitwise ORed set of values from cddb_flag_t.

void libcddb_set_flags (  unsigned int  flags  )

Set one or more flags that influence the library behvaiour. Parameters: flags  A bitwise ORed set of values from cddb_flag_t.

void libcddb_shutdown (  void   )

Frees up any global (cross connection) resources. You should call this function before terminating your program. Using any library calls after shutting down are bound to give problems.

---