<!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/sticker.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/sticker.h File Reference</h1> <p>MPD client library. <a href="#_details">More...</a></p> <p><a href="sticker_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="sticker_8h.html#abb6d5f5a8772b3a7257ddf4bbad59401">mpd_send_sticker_set</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, const char *type, const char *uri, const char *name, const char *value)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="sticker_8h.html#a1041af3bd18ead088a390ada30e50248">mpd_run_sticker_set</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, const char *type, const char *uri, const char *name, const char *value)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="sticker_8h.html#a5c13ef23a426ed4a6bf81954eb49325a">mpd_send_sticker_delete</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, const char *type, const char *uri, const char *name)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="sticker_8h.html#a35d2fd87165ace9b4ee66afdf1364914">mpd_run_sticker_delete</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, const char *type, const char *uri, const char *name)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="sticker_8h.html#a43554f9f7d1e1bcad5127060c83711d3">mpd_send_sticker_get</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, const char *type, const char *uri, const char *name)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="sticker_8h.html#afd1eae9c9c1d46597e79e03a590fad17">mpd_send_sticker_list</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, const char *type, const char *uri)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="sticker_8h.html#a623914681b6ed9d0618e15187b9ecfe3">mpd_send_sticker_find</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, const char *type, const char *base_uri, const char *name)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="sticker_8h.html#a7817da3dd7ccb278d675175c696c09be">mpd_parse_sticker</a> (const char *input, size_t *name_length_r)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">mpd_malloc struct <a class="el" href="structmpd__pair.html">mpd_pair</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="sticker_8h.html#ae14dc069d5d39020cf87a27e9ed8b11a">mpd_recv_sticker</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sticker_8h.html#ac60a39c609f203f23ede042ca85e5394">mpd_return_sticker</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, struct <a class="el" href="structmpd__pair.html">mpd_pair</a> *pair)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>MPD client library. </p> <p>Manipulate stickers.</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="sticker_8h_source.html">sticker.h</a>.</p> <hr/><h2>Function Documentation</h2> <a class="anchor" id="a7817da3dd7ccb278d675175c696c09be"></a><!-- doxytag: member="sticker.h::mpd_parse_sticker" ref="a7817da3dd7ccb278d675175c696c09be" args="(const char *input, size_t *name_length_r)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* mpd_parse_sticker </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>input</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t * </td> <td class="paramname"> <em>name_length_r</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Parse a sticker input line in the form "name=value".</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>input</em> </td><td>the input value, the value from a received pair named "sticker" </td></tr> <tr><td valign="top"></td><td valign="top"><em>name_length_r</em> </td><td>the length of the name (starting at the beginning of the input string) is returned here </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the sticker value, or NULL on error </dd></dl> </div> </div> <a class="anchor" id="ae14dc069d5d39020cf87a27e9ed8b11a"></a><!-- doxytag: member="sticker.h::mpd_recv_sticker" ref="ae14dc069d5d39020cf87a27e9ed8b11a" 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__pair.html">mpd_pair</a>* mpd_recv_sticker </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 sticker. You have to free the return value with <a class="el" href="sticker_8h.html#ac60a39c609f203f23ede042ca85e5394">mpd_return_sticker()</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 <a class="el" href="structmpd__pair.html">mpd_pair</a> object on success, NULL on end of response or error </dd></dl> </div> </div> <a class="anchor" id="ac60a39c609f203f23ede042ca85e5394"></a><!-- doxytag: member="sticker.h::mpd_return_sticker" ref="ac60a39c609f203f23ede042ca85e5394" args="(struct mpd_connection *connection, struct mpd_pair *pair)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void mpd_return_sticker </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">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>Free the pair returned by <a class="el" href="sticker_8h.html#ae14dc069d5d39020cf87a27e9ed8b11a">mpd_recv_sticker()</a>. </p> </div> </div> <a class="anchor" id="a35d2fd87165ace9b4ee66afdf1364914"></a><!-- doxytag: member="sticker.h::mpd_run_sticker_delete" ref="a35d2fd87165ace9b4ee66afdf1364914" args="(struct mpd_connection *connection, const char *type, const char *uri, const char *name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool mpd_run_sticker_delete </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>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>uri</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</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="sticker_8h.html#a5c13ef23a426ed4a6bf81954eb49325a">mpd_send_sticker_delete()</a> and <a class="el" href="response_8h.html#af59dc292f7df1ffce944972dd4a7150f">mpd_response_finish()</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>type</em> </td><td>the object type, e.g. "song" </td></tr> <tr><td valign="top"></td><td valign="top"><em>uri</em> </td><td>the URI of the object </td></tr> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the name of the sticker </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="a1041af3bd18ead088a390ada30e50248"></a><!-- doxytag: member="sticker.h::mpd_run_sticker_set" ref="a1041af3bd18ead088a390ada30e50248" args="(struct mpd_connection *connection, const char *type, const char *uri, const char *name, const char *value)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool mpd_run_sticker_set </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>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>uri</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>value</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="sticker_8h.html#abb6d5f5a8772b3a7257ddf4bbad59401">mpd_send_sticker_set()</a> and <a class="el" href="response_8h.html#af59dc292f7df1ffce944972dd4a7150f">mpd_response_finish()</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>type</em> </td><td>the object type, e.g. "song" </td></tr> <tr><td valign="top"></td><td valign="top"><em>uri</em> </td><td>the URI of the object </td></tr> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the name of the sticker </td></tr> <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value of the sticker </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="a5c13ef23a426ed4a6bf81954eb49325a"></a><!-- doxytag: member="sticker.h::mpd_send_sticker_delete" ref="a5c13ef23a426ed4a6bf81954eb49325a" args="(struct mpd_connection *connection, const char *type, const char *uri, const char *name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool mpd_send_sticker_delete </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>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>uri</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Deletes a sticker value.</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>type</em> </td><td>the object type, e.g. "song" </td></tr> <tr><td valign="top"></td><td valign="top"><em>uri</em> </td><td>the URI of the object </td></tr> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the name of the sticker </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="a623914681b6ed9d0618e15187b9ecfe3"></a><!-- doxytag: member="sticker.h::mpd_send_sticker_find" ref="a623914681b6ed9d0618e15187b9ecfe3" args="(struct mpd_connection *connection, const char *type, const char *base_uri, const char *name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool mpd_send_sticker_find </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>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>base_uri</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Searches for stickers with the specified name.</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>type</em> </td><td>the object type, e.g. "song" </td></tr> <tr><td valign="top"></td><td valign="top"><em>base_uri</em> </td><td>the base URI to start the search, e.g. a directory; NULL to search for all objects of the specified type </td></tr> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the name of the sticker </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="a43554f9f7d1e1bcad5127060c83711d3"></a><!-- doxytag: member="sticker.h::mpd_send_sticker_get" ref="a43554f9f7d1e1bcad5127060c83711d3" args="(struct mpd_connection *connection, const char *type, const char *uri, const char *name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool mpd_send_sticker_get </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>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>uri</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Queries a sticker value. Call <a class="el" href="sticker_8h.html#ae14dc069d5d39020cf87a27e9ed8b11a">mpd_recv_sticker()</a> to receive the response.</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>type</em> </td><td>the object type, e.g. "song" </td></tr> <tr><td valign="top"></td><td valign="top"><em>uri</em> </td><td>the URI of the object </td></tr> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the name of the sticker </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="afd1eae9c9c1d46597e79e03a590fad17"></a><!-- doxytag: member="sticker.h::mpd_send_sticker_list" ref="afd1eae9c9c1d46597e79e03a590fad17" args="(struct mpd_connection *connection, const char *type, const char *uri)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool mpd_send_sticker_list </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>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>uri</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Obtains a list of all stickers of the specified object. Call <a class="el" href="sticker_8h.html#ae14dc069d5d39020cf87a27e9ed8b11a">mpd_recv_sticker()</a> to receive each response item.</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>type</em> </td><td>the object type, e.g. "song" </td></tr> <tr><td valign="top"></td><td valign="top"><em>uri</em> </td><td>the URI of the object </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="abb6d5f5a8772b3a7257ddf4bbad59401"></a><!-- doxytag: member="sticker.h::mpd_send_sticker_set" ref="abb6d5f5a8772b3a7257ddf4bbad59401" args="(struct mpd_connection *connection, const char *type, const char *uri, const char *name, const char *value)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool mpd_send_sticker_set </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>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>uri</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>value</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Adds or replaces a sticker value.</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>type</em> </td><td>the object type, e.g. "song" </td></tr> <tr><td valign="top"></td><td valign="top"><em>uri</em> </td><td>the URI of the object </td></tr> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the name of the sticker </td></tr> <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>the value of the sticker </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:36 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>