<!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/list.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/list.h File Reference</h1>
<p>MPD client library.
<a href="#_details">More...</a></p>
<p><a href="list_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="list_8h.html#a8114db686514d2d23e617f6953922408">mpd_command_list_begin</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, bool discrete_ok)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="list_8h.html#af9bcbf40b904abf353893e941ad3c505">mpd_command_list_end</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>Functions for sending command lists.</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="list_8h_source.html">list.h</a>.</p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a8114db686514d2d23e617f6953922408"></a><!-- doxytag: member="list.h::mpd_command_list_begin" ref="a8114db686514d2d23e617f6953922408" args="(struct mpd_connection *connection, bool discrete_ok)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_command_list_begin </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">bool </td>
<td class="paramname"> <em>discrete_ok</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Starts a command list, i.e. a group of pipelined commands which are transferred in one block. If one command fails, the rest of the command list is canceled.</p>
<p>Note that there is no guarantee on atomicity.</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>discrete_ok</em> </td><td>tells MPD whether to acknowledge every list command with an "list_OK" response </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success </dd></dl>
</div>
</div>
<a class="anchor" id="af9bcbf40b904abf353893e941ad3c505"></a><!-- doxytag: member="list.h::mpd_command_list_end" ref="af9bcbf40b904abf353893e941ad3c505" args="(struct mpd_connection *connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_command_list_end </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>Commits the command list, i.e. makes MPD execute all commands which were queued.</p>
<p>Note: there is no way to cancel a command list once it is started. You may however close the socket connection.</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 </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>
