<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>libcddb: cddb.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="dir_d95480e064f2cd25d4e283edd80a73aa.html">include</a> » <a class="el" href="dir_847afe0584ab2be2f35afc524ae78865.html">cddb</a></div>
<h1>cddb.h File Reference</h1><code>#include <cddb/version.h></code><br>
<code>#include <cddb/cddb_config.h></code><br>
<code>#include <<a class="el" href="cddb__error_8h-source.html">cddb/cddb_error.h</a>></code><br>
<code>#include <<a class="el" href="cddb__track_8h-source.html">cddb/cddb_track.h</a>></code><br>
<code>#include <<a class="el" href="cddb__disc_8h-source.html">cddb/cddb_disc.h</a>></code><br>
<code>#include <<a class="el" href="cddb__site_8h-source.html">cddb/cddb_site.h</a>></code><br>
<code>#include <<a class="el" href="cddb__conn_8h-source.html">cddb/cddb_conn.h</a>></code><br>
<code>#include <<a class="el" href="cddb__cmd_8h-source.html">cddb/cddb_cmd.h</a>></code><br>
<code>#include <<a class="el" href="cddb__log_8h-source.html">cddb/cddb_log.h</a>></code><br>
<p>
<a href="cddb_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cddb_8h.html#c3e3a988f4156794378a9afe5ba70b6c">CDDB_H</a> 1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cddb_8h.html#3a8ea58898cb58fc96013383d39f482c">BIT</a>(n) (1 << n)</td></tr>
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="cddb_8h.html#94803409ace01b82c8c374cba100d2a0">cddb_flag_t</a> { <a class="el" href="cddb_8h.html#94803409ace01b82c8c374cba100d2a0bdda2a80163ac79b9f5e6ad0b7ae9e53">CDDB_F_EMPTY_STR</a> = BIT(0),
<a class="el" href="cddb_8h.html#94803409ace01b82c8c374cba100d2a05f8aba7d1ce9f532e361851d3920a664">CDDB_F_NO_TRACK_ARTIST</a> = BIT(1)
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An enumeration of flags that influence the behaviour of the library. <a href="cddb_8h.html#94803409ace01b82c8c374cba100d2a0">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="cddb_8h.html#1339baf6e3f3ead549c0f23610d85cf2">libcddb_init</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes the library. <a href="#1339baf6e3f3ead549c0f23610d85cf2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="cddb_8h.html#5a002ab61c0a144e140844f8705266de">libcddb_shutdown</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Frees up any global (cross connection) resources. <a href="#5a002ab61c0a144e140844f8705266de"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="cddb_8h.html#2ff51d1de4cb01be1fe28df563335c4a">libcddb_set_flags</a> (unsigned int flags)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set one or more flags that influence the library behvaiour. <a href="#2ff51d1de4cb01be1fe28df563335c4a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="cddb_8h.html#906aeed0760a43806f9bc95eefc63b3f">libcddb_reset_flags</a> (unsigned int flags)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset one or more flags that influence the library behvaiour. <a href="#906aeed0760a43806f9bc95eefc63b3f"></a><br></td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="3a8ea58898cb58fc96013383d39f482c"></a><!-- doxytag: member="cddb.h::BIT" ref="3a8ea58898cb58fc96013383d39f482c" args="(n)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define BIT </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">n </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> (1 << n)</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="c3e3a988f4156794378a9afe5ba70b6c"></a><!-- doxytag: member="cddb.h::CDDB_H" ref="c3e3a988f4156794378a9afe5ba70b6c" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define CDDB_H 1 </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="94803409ace01b82c8c374cba100d2a0"></a><!-- doxytag: member="cddb.h::cddb_flag_t" ref="94803409ace01b82c8c374cba100d2a0" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">enum <a class="el" href="cddb_8h.html#94803409ace01b82c8c374cba100d2a0">cddb_flag_t</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
An enumeration of flags that influence the behaviour of the library.
<p>
You can set or reset these flags using the <a class="el" href="cddb_8h.html#2ff51d1de4cb01be1fe28df563335c4a">libcddb_set_flags</a> and <a class="el" href="cddb_8h.html#906aeed0760a43806f9bc95eefc63b3f">libcddb_reset_flags</a> functions. <dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="94803409ace01b82c8c374cba100d2a0bdda2a80163ac79b9f5e6ad0b7ae9e53"></a><!-- doxytag: member="CDDB_F_EMPTY_STR" ref="94803409ace01b82c8c374cba100d2a0bdda2a80163ac79b9f5e6ad0b7ae9e53" args="" -->CDDB_F_EMPTY_STR</em> </td><td>
never return NULL pointer strings (default), return an empty string instead </td></tr>
<tr><td valign="top"><em><a class="anchor" name="94803409ace01b82c8c374cba100d2a05f8aba7d1ce9f532e361851d3920a664"></a><!-- doxytag: member="CDDB_F_NO_TRACK_ARTIST" ref="94803409ace01b82c8c374cba100d2a05f8aba7d1ce9f532e361851d3920a664" args="" -->CDDB_F_NO_TRACK_ARTIST</em> </td><td>
do not return the disc artist as the track artist (default), return NULL instead </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="1339baf6e3f3ead549c0f23610d85cf2"></a><!-- doxytag: member="cddb.h::libcddb_init" ref="1339baf6e3f3ead549c0f23610d85cf2" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void libcddb_init </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Initializes the library.
<p>
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. </td>
</tr>
</table>
<a class="anchor" name="906aeed0760a43806f9bc95eefc63b3f"></a><!-- doxytag: member="cddb.h::libcddb_reset_flags" ref="906aeed0760a43806f9bc95eefc63b3f" args="(unsigned int flags)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void libcddb_reset_flags </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned int </td>
<td class="mdname1" valign="top" nowrap> <em>flags</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Reset one or more flags that influence the library behvaiour.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>flags</em> </td><td>A bitwise ORed set of values from <a class="el" href="cddb_8h.html#94803409ace01b82c8c374cba100d2a0">cddb_flag_t</a>. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="2ff51d1de4cb01be1fe28df563335c4a"></a><!-- doxytag: member="cddb.h::libcddb_set_flags" ref="2ff51d1de4cb01be1fe28df563335c4a" args="(unsigned int flags)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void libcddb_set_flags </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned int </td>
<td class="mdname1" valign="top" nowrap> <em>flags</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set one or more flags that influence the library behvaiour.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>flags</em> </td><td>A bitwise ORed set of values from <a class="el" href="cddb_8h.html#94803409ace01b82c8c374cba100d2a0">cddb_flag_t</a>. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="5a002ab61c0a144e140844f8705266de"></a><!-- doxytag: member="cddb.h::libcddb_shutdown" ref="5a002ab61c0a144e140844f8705266de" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void libcddb_shutdown </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Frees up any global (cross connection) resources.
<p>
You should call this function before terminating your program. Using any library calls after shutting down are bound to give problems. </td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Sun Oct 15 14:49:14 2006 for libcddb by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
