<!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/directory.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/directory.h File Reference</h1>
<p>MPD client library.
<a href="#_details">More...</a></p>
<p><a href="directory_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">mpd_malloc struct <a class="el" href="structmpd__directory.html">mpd_directory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="directory_8h.html#a36ea399376529d05d0268ee320240352">mpd_directory_dup</a> (const struct <a class="el" href="structmpd__directory.html">mpd_directory</a> *directory)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="directory_8h.html#aca2f3119eb1e8855949859c8f970db0a">mpd_directory_free</a> (struct <a class="el" href="structmpd__directory.html">mpd_directory</a> *directory)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_pure const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="directory_8h.html#a75d098bd3ed16d5db81e9c8060469dfb">mpd_directory_get_path</a> (const struct <a class="el" href="structmpd__directory.html">mpd_directory</a> *directory)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_malloc struct <a class="el" href="structmpd__directory.html">mpd_directory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="directory_8h.html#a783901c4230f70cf1dd1e558919ae06e">mpd_directory_begin</a> (const struct <a class="el" href="structmpd__pair.html">mpd_pair</a> *pair)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="directory_8h.html#a4403e3d4255ef2e1efe5ba952345e6c7">mpd_directory_feed</a> (struct <a class="el" href="structmpd__directory.html">mpd_directory</a> *directory, const struct <a class="el" href="structmpd__pair.html">mpd_pair</a> *pair)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_malloc struct <a class="el" href="structmpd__directory.html">mpd_directory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="directory_8h.html#a5b6805fdf1581977a575bf225400f7ac">mpd_recv_directory</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>MPD client library. </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="directory_8h_source.html">directory.h</a>.</p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a783901c4230f70cf1dd1e558919ae06e"></a><!-- doxytag: member="directory.h::mpd_directory_begin" ref="a783901c4230f70cf1dd1e558919ae06e" args="(const struct mpd_pair *pair)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_malloc struct <a class="el" href="structmpd__directory.html">mpd_directory</a>* mpd_directory_begin </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structmpd__pair.html">mpd_pair</a> * </td>
<td class="paramname"> <em>pair</em></td>
<td> ) </td>
<td><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Begins parsing a new directory.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pair</em> </td><td>the first pair in this directory (name must be "directory") </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the new <a class="el" href="structmpd__entity.html">mpd_entity</a> object, or NULL on error (out of memory, or pair name is not "directory") </dd></dl>
</div>
</div>
<a class="anchor" id="a36ea399376529d05d0268ee320240352"></a><!-- doxytag: member="directory.h::mpd_directory_dup" ref="a36ea399376529d05d0268ee320240352" args="(const struct mpd_directory *directory)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_malloc struct <a class="el" href="structmpd__directory.html">mpd_directory</a>* mpd_directory_dup </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structmpd__directory.html">mpd_directory</a> * </td>
<td class="paramname"> <em>directory</em></td>
<td> ) </td>
<td><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Duplicates a <a class="el" href="structmpd__directory.html">mpd_directory</a> object.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the new object, or NULL on out of memory </dd></dl>
</div>
</div>
<a class="anchor" id="a4403e3d4255ef2e1efe5ba952345e6c7"></a><!-- doxytag: member="directory.h::mpd_directory_feed" ref="a4403e3d4255ef2e1efe5ba952345e6c7" args="(struct mpd_directory *directory, const struct mpd_pair *pair)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_directory_feed </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__directory.html">mpd_directory</a> * </td>
<td class="paramname"> <em>directory</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const struct <a class="el" href="structmpd__pair.html">mpd_pair</a> * </td>
<td class="paramname"> <em>pair</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parses the pair, adding its information to the specified <a class="el" href="structmpd__directory.html">mpd_directory</a> object.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the pair was parsed and added to the directory (or if the pair was not understood and ignored), false if this pair is the beginning of the next directory </dd></dl>
</div>
</div>
<a class="anchor" id="aca2f3119eb1e8855949859c8f970db0a"></a><!-- doxytag: member="directory.h::mpd_directory_free" ref="aca2f3119eb1e8855949859c8f970db0a" args="(struct mpd_directory *directory)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mpd_directory_free </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__directory.html">mpd_directory</a> * </td>
<td class="paramname"> <em>directory</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Free memory allocated by the <a class="el" href="structmpd__directory.html">mpd_directory</a> object. </p>
</div>
</div>
<a class="anchor" id="a75d098bd3ed16d5db81e9c8060469dfb"></a><!-- doxytag: member="directory.h::mpd_directory_get_path" ref="a75d098bd3ed16d5db81e9c8060469dfb" args="(const struct mpd_directory *directory)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_pure const char* mpd_directory_get_path </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structmpd__directory.html">mpd_directory</a> * </td>
<td class="paramname"> <em>directory</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the path of this directory, relative to the MPD music directory. It does not begin with a slash. </p>
</div>
</div>
<a class="anchor" id="a5b6805fdf1581977a575bf225400f7ac"></a><!-- doxytag: member="directory.h::mpd_recv_directory" ref="a5b6805fdf1581977a575bf225400f7ac" args="(struct mpd_connection *connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_malloc struct <a class="el" href="structmpd__directory.html">mpd_directory</a>* mpd_recv_directory </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><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Receives the next directory from the MPD server.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a <a class="el" href="structmpd__directory.html">mpd_directory</a> object, or NULL on error or if the directory list is finished </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>
