<!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/capabilities.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/capabilities.h File Reference</h1>
<p>MPD client library.
<a href="#_details">More...</a></p>
<p><a href="capabilities_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="capabilities_8h.html#acf33b03fa527370c925ce2484cc9b7bd">mpd_send_allowed_commands</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="capabilities_8h.html#a1d51c58b374e318afdf84d9237fc11b2">mpd_send_disallowed_commands</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static mpd_malloc struct <a class="el" href="structmpd__pair.html">mpd_pair</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="capabilities_8h.html#a32bd96eacff30180baf73cf867d1550b">mpd_recv_command_pair</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="capabilities_8h.html#a0bed9254717f0af6473b51538e2899f0">mpd_send_list_url_schemes</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static mpd_malloc struct <a class="el" href="structmpd__pair.html">mpd_pair</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="capabilities_8h.html#a461ae9f2a31144f3148c6665282c4783">mpd_recv_url_scheme_pair</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="capabilities_8h.html#ab2e1427a11be31062c0f787a258cfad6">mpd_send_list_tag_types</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static mpd_malloc struct <a class="el" href="structmpd__pair.html">mpd_pair</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="capabilities_8h.html#ae6218691a56486261371b2667d27598d">mpd_recv_tag_type_pair</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="capabilities_8h_source.html">capabilities.h</a>.</p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a32bd96eacff30180baf73cf867d1550b"></a><!-- doxytag: member="capabilities.h::mpd_recv_command_pair" ref="a32bd96eacff30180baf73cf867d1550b" args="(struct mpd_connection *connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static mpd_malloc struct <a class="el" href="structmpd__pair.html">mpd_pair</a>* mpd_recv_command_pair </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> [static, read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Receives the next supported command. Call this in a loop after mpd_send_commands() or mpd_send_notcommands().</p>
<p>Free the return value with <a class="el" href="recv_8h.html#ac86994a4fdd677e8d3e4aec23c6a865f">mpd_return_pair()</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>a <a class="el" href="structmpd__connection.html">mpd_connection</a> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a "command" pair, or NULL on error or if the end of the response is reached </dd></dl>
<p>Definition at line <a class="el" href="capabilities_8h_source.html#l00082">82</a> of file <a class="el" href="capabilities_8h_source.html">capabilities.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae6218691a56486261371b2667d27598d"></a><!-- doxytag: member="capabilities.h::mpd_recv_tag_type_pair" ref="ae6218691a56486261371b2667d27598d" args="(struct mpd_connection *connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static mpd_malloc struct <a class="el" href="structmpd__pair.html">mpd_pair</a>* mpd_recv_tag_type_pair </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> [static, read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Receives the next tag type name. Call this in a loop after mpd_send_tagtypes().</p>
<p>Free the return value with <a class="el" href="recv_8h.html#ac86994a4fdd677e8d3e4aec23c6a865f">mpd_return_pair()</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>a <a class="el" href="structmpd__connection.html">mpd_connection</a> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a "handler" pair, or NULL on error or if the end of the response is reached </dd></dl>
<p>Definition at line <a class="el" href="capabilities_8h_source.html#l00136">136</a> of file <a class="el" href="capabilities_8h_source.html">capabilities.h</a>.</p>
</div>
</div>
<a class="anchor" id="a461ae9f2a31144f3148c6665282c4783"></a><!-- doxytag: member="capabilities.h::mpd_recv_url_scheme_pair" ref="a461ae9f2a31144f3148c6665282c4783" args="(struct mpd_connection *connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static mpd_malloc struct <a class="el" href="structmpd__pair.html">mpd_pair</a>* mpd_recv_url_scheme_pair </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> [static, read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Receives one line of the mpd_send_urlhandlers() response.</p>
<p>Free the return value with <a class="el" href="recv_8h.html#ac86994a4fdd677e8d3e4aec23c6a865f">mpd_return_pair()</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>a <a class="el" href="structmpd__connection.html">mpd_connection</a> </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a "handler" pair, or NULL on error or if the end of the response is reached </dd></dl>
<p>Definition at line <a class="el" href="capabilities_8h_source.html#l00109">109</a> of file <a class="el" href="capabilities_8h_source.html">capabilities.h</a>.</p>
</div>
</div>
<a class="anchor" id="acf33b03fa527370c925ce2484cc9b7bd"></a><!-- doxytag: member="capabilities.h::mpd_send_allowed_commands" ref="acf33b03fa527370c925ce2484cc9b7bd" args="(struct mpd_connection *connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_send_allowed_commands </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>Requests a list of supported and allowed. Use <a class="el" href="recv_8h.html#aa7a5a26852b97f72c9f31fa742f6b7eb">mpd_recv_pair_named()</a> to obtain the list of "command" pairs.</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>true on success, false on error </dd></dl>
</div>
</div>
<a class="anchor" id="a1d51c58b374e318afdf84d9237fc11b2"></a><!-- doxytag: member="capabilities.h::mpd_send_disallowed_commands" ref="a1d51c58b374e318afdf84d9237fc11b2" args="(struct mpd_connection *connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_send_disallowed_commands </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>Requests a list of supported commands which are not allowed for this connection. Use <a class="el" href="recv_8h.html#aa7a5a26852b97f72c9f31fa742f6b7eb">mpd_recv_pair_named()</a> to obtain the list of "command" pairs.</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>true on success, false on error </dd></dl>
</div>
</div>
<a class="anchor" id="ab2e1427a11be31062c0f787a258cfad6"></a><!-- doxytag: member="capabilities.h::mpd_send_list_tag_types" ref="ab2e1427a11be31062c0f787a258cfad6" args="(struct mpd_connection *connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_send_list_tag_types </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>Requests a list of supported tag types. Use <a class="el" href="recv_8h.html#aa7a5a26852b97f72c9f31fa742f6b7eb">mpd_recv_pair_named()</a> to obtain the list of "tagtype" pairs.</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>true on success, false on error </dd></dl>
</div>
</div>
<a class="anchor" id="a0bed9254717f0af6473b51538e2899f0"></a><!-- doxytag: member="capabilities.h::mpd_send_list_url_schemes" ref="a0bed9254717f0af6473b51538e2899f0" args="(struct mpd_connection *connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_send_list_url_schemes </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>Requests a list of supported URL handlers in the form "scheme://", example: "http://". Use <a class="el" href="recv_8h.html#aa7a5a26852b97f72c9f31fa742f6b7eb">mpd_recv_pair_named()</a> to obtain the list of "handler" pairs.</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>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>
