<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libmpdclient: mpd/database.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</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>
<div class="contents">
<h1>mpd/database.h File Reference</h1>
<p>Database.
<a href="#_details">More...</a></p>
<p><a href="database_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="database_8h.html#a0345ac5c4cb0bf1a7c96e22814fe2ade">mpd_send_list_all</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, const char *path)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="database_8h.html#ad9d78d3c9a9cc37d8ed11bcb29630556">mpd_send_list_all_meta</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, const char *path)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="database_8h.html#a449d17f9193dc4f0fbe2847024e40833">mpd_send_list_meta</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, const char *path)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="database_8h.html#a244724dceea1b07bbaa05a943ae93d88">mpd_send_update</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, const char *path)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="database_8h.html#ab8fb1b64a7ab272079b67d26d17620dd">mpd_send_rescan</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, const char *path)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="database_8h.html#a745e8fa8e22b5be05f8e0f8f21bbeb28">mpd_recv_update_id</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="database_8h.html#a79c00ab77560a0cceaca96633f8762e3">mpd_run_update</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, const char *path)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="database_8h.html#a09ed0c99acd56e007c2d8914c8a7bee6">mpd_run_rescan</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, const char *path)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Database. </p>
<p>This file declares functions which query or update MPD's music database.</p>
<p>Do not include this header directly. Use <a class="el" href="client_8h.html" title="MPD client library.">mpd/client.h</a> instead. </p>
<p>Definition in file <a class="el" href="database_8h_source.html">database.h</a>.</p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a745e8fa8e22b5be05f8e0f8f21bbeb28"></a><!-- doxytag: member="database.h::mpd_recv_update_id" ref="a745e8fa8e22b5be05f8e0f8f21bbeb28" args="(struct mpd_connection *connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned mpd_recv_update_id </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__connection.html">mpd_connection</a> * </td>
<td class="paramname"> <em>connection</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Receives the id the of the update job which was submitted by <a class="el" href="database_8h.html#a244724dceea1b07bbaa05a943ae93d88">mpd_send_update()</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td>the connection to MPD </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a positive job id on success, 0 on error </dd></dl>
</div>
</div>
<a class="anchor" id="a09ed0c99acd56e007c2d8914c8a7bee6"></a><!-- doxytag: member="database.h::mpd_run_rescan" ref="a09ed0c99acd56e007c2d8914c8a7bee6" args="(struct mpd_connection *connection, const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned mpd_run_rescan </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__connection.html">mpd_connection</a> * </td>
<td class="paramname"> <em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Like <a class="el" href="database_8h.html#a79c00ab77560a0cceaca96633f8762e3">mpd_run_update()</a>, but also rescans unmodified files.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td>the connection to MPD </td></tr>
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>optional path to update; if NULL, then all of the music directory is updated </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a positive job id on success, 0 on error </dd></dl>
</div>
</div>
<a class="anchor" id="a79c00ab77560a0cceaca96633f8762e3"></a><!-- doxytag: member="database.h::mpd_run_update" ref="a79c00ab77560a0cceaca96633f8762e3" args="(struct mpd_connection *connection, const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned mpd_run_update </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__connection.html">mpd_connection</a> * </td>
<td class="paramname"> <em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Shortcut for <a class="el" href="database_8h.html#a244724dceea1b07bbaa05a943ae93d88">mpd_send_update()</a> and <a class="el" href="database_8h.html#a745e8fa8e22b5be05f8e0f8f21bbeb28">mpd_recv_update_id()</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td>the connection to MPD </td></tr>
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>optional path to update; if NULL, then all of the music directory is updated </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a positive job id on success, 0 on error </dd></dl>
</div>
</div>
<a class="anchor" id="a0345ac5c4cb0bf1a7c96e22814fe2ade"></a><!-- doxytag: member="database.h::mpd_send_list_all" ref="a0345ac5c4cb0bf1a7c96e22814fe2ade" args="(struct mpd_connection *connection, const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_send_list_all </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__connection.html">mpd_connection</a> * </td>
<td class="paramname"> <em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a recursive list of all directories, songs and playlist from MPD. They are returned without metadata. This is a rather expensive operation, because the response may be large.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td>the connection to MPD </td></tr>
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>an optional base path for the query </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, false on error </dd></dl>
</div>
</div>
<a class="anchor" id="ad9d78d3c9a9cc37d8ed11bcb29630556"></a><!-- doxytag: member="database.h::mpd_send_list_all_meta" ref="ad9d78d3c9a9cc37d8ed11bcb29630556" args="(struct mpd_connection *connection, const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_send_list_all_meta </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__connection.html">mpd_connection</a> * </td>
<td class="paramname"> <em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Like <a class="el" href="database_8h.html#a0345ac5c4cb0bf1a7c96e22814fe2ade">mpd_send_list_all()</a>, but return metadata. This operation is even more expensive, because the response is larger. If it is larger than a configurable server-side limit, MPD may disconnect you.</p>
<p>To read the response, you may use <a class="el" href="entity_8h.html#a274a62a5d9d73ce63c509aa8c7eadc6d">mpd_recv_entity()</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td>the connection to MPD </td></tr>
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>an optional base path for the query </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, false on error </dd></dl>
</div>
</div>
<a class="anchor" id="a449d17f9193dc4f0fbe2847024e40833"></a><!-- doxytag: member="database.h::mpd_send_list_meta" ref="a449d17f9193dc4f0fbe2847024e40833" args="(struct mpd_connection *connection, const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_send_list_meta </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__connection.html">mpd_connection</a> * </td>
<td class="paramname"> <em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a list of all directories, songs and playlist in a directory from MPD, including metadata.</p>
<p>To read the response, you may use <a class="el" href="entity_8h.html#a274a62a5d9d73ce63c509aa8c7eadc6d">mpd_recv_entity()</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td>the connection to MPD </td></tr>
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>the directory to be listed </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, false on error </dd></dl>
</div>
</div>
<a class="anchor" id="ab8fb1b64a7ab272079b67d26d17620dd"></a><!-- doxytag: member="database.h::mpd_send_rescan" ref="ab8fb1b64a7ab272079b67d26d17620dd" args="(struct mpd_connection *connection, const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_send_rescan </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__connection.html">mpd_connection</a> * </td>
<td class="paramname"> <em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Like <a class="el" href="database_8h.html#a244724dceea1b07bbaa05a943ae93d88">mpd_send_update()</a>, but also rescans unmodified files.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td>the connection to MPD </td></tr>
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>optional path to update; if NULL, then all of the music directory is updated </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, false on error </dd></dl>
</div>
</div>
<a class="anchor" id="a244724dceea1b07bbaa05a943ae93d88"></a><!-- doxytag: member="database.h::mpd_send_update" ref="a244724dceea1b07bbaa05a943ae93d88" args="(struct mpd_connection *connection, const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_send_update </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__connection.html">mpd_connection</a> * </td>
<td class="paramname"> <em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Instructs MPD to update the music database: find new files, remove deleted files, update modified files.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td>the connection to MPD </td></tr>
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>optional path to update; if NULL, then all of the music directory is updated </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, false on error </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sun Aug 8 15:52:35 2010 for libmpdclient by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
