<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3.1"/> <title>libmusicbrainz5: MusicBrainz5::CQuery Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">libmusicbrainz5  <span id="projectnumber">5.0.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('class_music_brainz5_1_1_c_query.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="class_music_brainz5_1_1_c_query-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">MusicBrainz5::CQuery Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>Main object for generating queries to MusicBrainz. <a href="class_music_brainz5_1_1_c_query.html#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> Public Types</h2></td></tr> <tr class="memitem:aae350311e3035fc9e6dbe9262bd4e6a5"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz5_1_1_c_query.html#aae350311e3035fc9e6dbe9262bd4e6a5">tQueryResult</a> { <br/>   <a class="el" href="class_music_brainz5_1_1_c_query.html#aae350311e3035fc9e6dbe9262bd4e6a5a29409759a3ebda53e69e2b76f7f22687">eQuery_Success</a> =0, <a class="el" href="class_music_brainz5_1_1_c_query.html#aae350311e3035fc9e6dbe9262bd4e6a5ae748ec5fb0433671d15b1353e204e471">eQuery_ConnectionError</a>, <a class="el" href="class_music_brainz5_1_1_c_query.html#aae350311e3035fc9e6dbe9262bd4e6a5a1f27d175fc9183b9c470196a0771659a">eQuery_Timeout</a>, <a class="el" href="class_music_brainz5_1_1_c_query.html#aae350311e3035fc9e6dbe9262bd4e6a5a052750f1a8d88797f7073b48dcabafba">eQuery_AuthenticationError</a>, <br/>   <a class="el" href="class_music_brainz5_1_1_c_query.html#aae350311e3035fc9e6dbe9262bd4e6a5afc4518286b98dacae40dbfbd238e1e23">eQuery_FetchError</a>, <a class="el" href="class_music_brainz5_1_1_c_query.html#aae350311e3035fc9e6dbe9262bd4e6a5a04d123354eeac5ffc6d2ad30c8fbece2">eQuery_RequestError</a>, <a class="el" href="class_music_brainz5_1_1_c_query.html#aae350311e3035fc9e6dbe9262bd4e6a5a38b912a5cf39df38b82ce84d0d6c9af2">eQuery_ResourceNotFound</a> <br/> }</td></tr> <tr class="memdesc:aae350311e3035fc9e6dbe9262bd4e6a5"><td class="mdescLeft"> </td><td class="mdescRight">Enumerated type for query status. <a href="class_music_brainz5_1_1_c_query.html#aae350311e3035fc9e6dbe9262bd4e6a5">More...</a><br/></td></tr> <tr class="separator:aae350311e3035fc9e6dbe9262bd4e6a5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a836013cd0d3870936e0a95fed7434968"><td class="memItemLeft" align="right" valign="top">typedef std::map< std::string, <br class="typebreak"/> std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz5_1_1_c_query.html#a836013cd0d3870936e0a95fed7434968">tParamMap</a></td></tr> <tr class="separator:a836013cd0d3870936e0a95fed7434968"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:af6694483cf7c89847a8f9ba19cf6a951"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz5_1_1_c_query.html#af6694483cf7c89847a8f9ba19cf6a951">CQuery</a> (const std::string &UserAgent, const std::string &Server="musicbrainz.org", int Port=80)</td></tr> <tr class="memdesc:af6694483cf7c89847a8f9ba19cf6a951"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for MusicBrainz::CQuery object. <a href="#af6694483cf7c89847a8f9ba19cf6a951">More...</a><br/></td></tr> <tr class="separator:af6694483cf7c89847a8f9ba19cf6a951"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5815d813ce48500b2996b4139278ee08"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz5_1_1_c_query.html#a5815d813ce48500b2996b4139278ee08">~CQuery</a> ()</td></tr> <tr class="separator:a5815d813ce48500b2996b4139278ee08"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad8cbaf48b4ecfb227642d78181fd9948"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz5_1_1_c_query.html#ad8cbaf48b4ecfb227642d78181fd9948">SetUserName</a> (const std::string &UserName)</td></tr> <tr class="memdesc:ad8cbaf48b4ecfb227642d78181fd9948"><td class="mdescLeft"> </td><td class="mdescRight">Set the user name. <a href="#ad8cbaf48b4ecfb227642d78181fd9948">More...</a><br/></td></tr> <tr class="separator:ad8cbaf48b4ecfb227642d78181fd9948"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a093a951cf3a09e8459d0709ecf66c0fc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz5_1_1_c_query.html#a093a951cf3a09e8459d0709ecf66c0fc">SetPassword</a> (const std::string &Password)</td></tr> <tr class="memdesc:a093a951cf3a09e8459d0709ecf66c0fc"><td class="mdescLeft"> </td><td class="mdescRight">Set the password. <a href="#a093a951cf3a09e8459d0709ecf66c0fc">More...</a><br/></td></tr> <tr class="separator:a093a951cf3a09e8459d0709ecf66c0fc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab237049b014dc5328ebed3f27d33bda2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz5_1_1_c_query.html#ab237049b014dc5328ebed3f27d33bda2">SetProxyHost</a> (const std::string &ProxyHost)</td></tr> <tr class="memdesc:ab237049b014dc5328ebed3f27d33bda2"><td class="mdescLeft"> </td><td class="mdescRight">Set proxy server. <a href="#ab237049b014dc5328ebed3f27d33bda2">More...</a><br/></td></tr> <tr class="separator:ab237049b014dc5328ebed3f27d33bda2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a76aec7e307ebb5b0f0c2435b8a3eb43e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz5_1_1_c_query.html#a76aec7e307ebb5b0f0c2435b8a3eb43e">SetProxyPort</a> (int ProxyPort)</td></tr> <tr class="memdesc:a76aec7e307ebb5b0f0c2435b8a3eb43e"><td class="mdescLeft"> </td><td class="mdescRight">Set proxy server port. <a href="#a76aec7e307ebb5b0f0c2435b8a3eb43e">More...</a><br/></td></tr> <tr class="separator:a76aec7e307ebb5b0f0c2435b8a3eb43e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a87cdf7899544d6fbb3a6263010780d54"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz5_1_1_c_query.html#a87cdf7899544d6fbb3a6263010780d54">SetProxyUserName</a> (const std::string &ProxyUserName)</td></tr> <tr class="memdesc:a87cdf7899544d6fbb3a6263010780d54"><td class="mdescLeft"> </td><td class="mdescRight">Set proxy server user name. <a href="#a87cdf7899544d6fbb3a6263010780d54">More...</a><br/></td></tr> <tr class="separator:a87cdf7899544d6fbb3a6263010780d54"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae8c3f30511c5c338eb9f054c214c4e1f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz5_1_1_c_query.html#ae8c3f30511c5c338eb9f054c214c4e1f">SetProxyPassword</a> (const std::string &ProxyPassword)</td></tr> <tr class="memdesc:ae8c3f30511c5c338eb9f054c214c4e1f"><td class="mdescLeft"> </td><td class="mdescRight">Set proxy server password. <a href="#ae8c3f30511c5c338eb9f054c214c4e1f">More...</a><br/></td></tr> <tr class="separator:ae8c3f30511c5c338eb9f054c214c4e1f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac7a58a495fabb8f1100c101730cf44d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespace_music_brainz5.html#ab4da2dc2496a9cd019d8383e985a9a6b">CReleaseList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz5_1_1_c_query.html#ac7a58a495fabb8f1100c101730cf44d4">LookupDiscID</a> (const std::string &DiscID)</td></tr> <tr class="memdesc:ac7a58a495fabb8f1100c101730cf44d4"><td class="mdescLeft"> </td><td class="mdescRight">Return a list of releases that match a disc ID. <a href="#ac7a58a495fabb8f1100c101730cf44d4">More...</a><br/></td></tr> <tr class="separator:ac7a58a495fabb8f1100c101730cf44d4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a20f37001e88266b85cf7b8b5c9c5ccb5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz5_1_1_c_release.html">CRelease</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz5_1_1_c_query.html#a20f37001e88266b85cf7b8b5c9c5ccb5">LookupRelease</a> (const std::string &ReleaseID)</td></tr> <tr class="memdesc:a20f37001e88266b85cf7b8b5c9c5ccb5"><td class="mdescLeft"> </td><td class="mdescRight">Return full information about a release. <a href="#a20f37001e88266b85cf7b8b5c9c5ccb5">More...</a><br/></td></tr> <tr class="separator:a20f37001e88266b85cf7b8b5c9c5ccb5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abe151c7483ac026df73bd76c23d9b9dd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz5_1_1_c_metadata.html">CMetadata</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz5_1_1_c_query.html#abe151c7483ac026df73bd76c23d9b9dd">Query</a> (const std::string &Entity, const std::string &ID="", const std::string &Resource="", const <a class="el" href="class_music_brainz5_1_1_c_query.html#a836013cd0d3870936e0a95fed7434968">tParamMap</a> &Params=<a class="el" href="class_music_brainz5_1_1_c_query.html#a836013cd0d3870936e0a95fed7434968">tParamMap</a>())</td></tr> <tr class="memdesc:abe151c7483ac026df73bd76c23d9b9dd"><td class="mdescLeft"> </td><td class="mdescRight">Perform a generic query. <a href="#abe151c7483ac026df73bd76c23d9b9dd">More...</a><br/></td></tr> <tr class="separator:abe151c7483ac026df73bd76c23d9b9dd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a66e86c0428ac7cb26f3f14522eed046b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz5_1_1_c_query.html#a66e86c0428ac7cb26f3f14522eed046b">AddCollectionEntries</a> (const std::string &CollectionID, const std::vector< std::string > &Entries)</td></tr> <tr class="memdesc:a66e86c0428ac7cb26f3f14522eed046b"><td class="mdescLeft"> </td><td class="mdescRight">Add entries to the specified collection. <a href="#a66e86c0428ac7cb26f3f14522eed046b">More...</a><br/></td></tr> <tr class="separator:a66e86c0428ac7cb26f3f14522eed046b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab9675feb17771c28ef4c57e318fa09f1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz5_1_1_c_query.html#ab9675feb17771c28ef4c57e318fa09f1">DeleteCollectionEntries</a> (const std::string &CollectionID, const std::vector< std::string > &Entries)</td></tr> <tr class="memdesc:ab9675feb17771c28ef4c57e318fa09f1"><td class="mdescLeft"> </td><td class="mdescRight">Delete entries from the specified collection. <a href="#ab9675feb17771c28ef4c57e318fa09f1">More...</a><br/></td></tr> <tr class="separator:ab9675feb17771c28ef4c57e318fa09f1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0d82316a3b5468bd63cb97c5c018fab3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz5_1_1_c_query.html#aae350311e3035fc9e6dbe9262bd4e6a5">CQuery::tQueryResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz5_1_1_c_query.html#a0d82316a3b5468bd63cb97c5c018fab3">LastResult</a> () const </td></tr> <tr class="memdesc:a0d82316a3b5468bd63cb97c5c018fab3"><td class="mdescLeft"> </td><td class="mdescRight">Return result of the last query. <a href="#a0d82316a3b5468bd63cb97c5c018fab3">More...</a><br/></td></tr> <tr class="separator:a0d82316a3b5468bd63cb97c5c018fab3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a73bdf9c1c3799fb190f30d7ce58a8fef"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz5_1_1_c_query.html#a73bdf9c1c3799fb190f30d7ce58a8fef">LastHTTPCode</a> () const </td></tr> <tr class="memdesc:a73bdf9c1c3799fb190f30d7ce58a8fef"><td class="mdescLeft"> </td><td class="mdescRight">Return HTTP code of the last query. <a href="#a73bdf9c1c3799fb190f30d7ce58a8fef">More...</a><br/></td></tr> <tr class="separator:a73bdf9c1c3799fb190f30d7ce58a8fef"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abfffd654b4c4d56dfa4f032a9904de66"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz5_1_1_c_query.html#abfffd654b4c4d56dfa4f032a9904de66">LastErrorMessage</a> () const </td></tr> <tr class="memdesc:abfffd654b4c4d56dfa4f032a9904de66"><td class="mdescLeft"> </td><td class="mdescRight">Return error message from the last query. <a href="#abfffd654b4c4d56dfa4f032a9904de66">More...</a><br/></td></tr> <tr class="separator:abfffd654b4c4d56dfa4f032a9904de66"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0559681143d4ef8af8b96ba42b75590f"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz5_1_1_c_query.html#a0559681143d4ef8af8b96ba42b75590f">Version</a> () const </td></tr> <tr class="memdesc:a0559681143d4ef8af8b96ba42b75590f"><td class="mdescLeft"> </td><td class="mdescRight">Return the library version. <a href="#a0559681143d4ef8af8b96ba42b75590f">More...</a><br/></td></tr> <tr class="separator:a0559681143d4ef8af8b96ba42b75590f"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>This object is the main entry point for the library, generating a query to the MusicBrainz service, and parsing the results. The resultant objects can be used to retrieve information appropriate to the query.</p> <p>For information on generating queries and the expected responses, see the documentation for the <a href="http://musicbrainz.org/doc/XML_Web_Service/Version_2" target="_blank">web service</a>.</p> <p>For information on search syntax, see the documentation for <a href="http://wiki.musicbrainz.org/Text_Search_Syntax" target="_blank">search syntax</a>.</p> <p><b>Note</b> It is the responsibility of the caller to validate any pointers returned from the library. It is valid for a pointer to be NULL if the information was not present in the response from the MusicBrainz service.</p> <p><b>Note</b> The ownership of any pointers returned from the C++ interfaces remains with the library. The caller should not delete any pointer returned from the library. Users of the C library should take note of the documentation for each individual function in <a class="el" href="mb5__c_8h.html">mb5_c.h</a> </p> </div><h2 class="groupheader">Member Typedef Documentation</h2> <a class="anchor" id="a836013cd0d3870936e0a95fed7434968"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef std::map<std::string,std::string> <a class="el" href="class_music_brainz5_1_1_c_query.html#a836013cd0d3870936e0a95fed7434968">MusicBrainz5::CQuery::tParamMap</a></td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Enumeration Documentation</h2> <a class="anchor" id="aae350311e3035fc9e6dbe9262bd4e6a5"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="class_music_brainz5_1_1_c_query.html#aae350311e3035fc9e6dbe9262bd4e6a5">MusicBrainz5::CQuery::tQueryResult</a></td> </tr> </table> </div><div class="memdoc"> <p>Enumerated type for query status </p> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="aae350311e3035fc9e6dbe9262bd4e6a5a29409759a3ebda53e69e2b76f7f22687"></a>eQuery_Success</em> </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="aae350311e3035fc9e6dbe9262bd4e6a5ae748ec5fb0433671d15b1353e204e471"></a>eQuery_ConnectionError</em> </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="aae350311e3035fc9e6dbe9262bd4e6a5a1f27d175fc9183b9c470196a0771659a"></a>eQuery_Timeout</em> </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="aae350311e3035fc9e6dbe9262bd4e6a5a052750f1a8d88797f7073b48dcabafba"></a>eQuery_AuthenticationError</em> </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="aae350311e3035fc9e6dbe9262bd4e6a5afc4518286b98dacae40dbfbd238e1e23"></a>eQuery_FetchError</em> </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="aae350311e3035fc9e6dbe9262bd4e6a5a04d123354eeac5ffc6d2ad30c8fbece2"></a>eQuery_RequestError</em> </td><td class="fielddoc"> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="aae350311e3035fc9e6dbe9262bd4e6a5a38b912a5cf39df38b82ce84d0d6c9af2"></a>eQuery_ResourceNotFound</em> </td><td class="fielddoc"> </td></tr> </table> </div> </div> <h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="af6694483cf7c89847a8f9ba19cf6a951"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">MusicBrainz5::CQuery::CQuery </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>UserAgent</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>Server</em> = <code>"musicbrainz.org"</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>Port</em> = <code>80</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>This is the constructor for the MusicBrainz::CQuery object.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">UserAgent</td><td>User agent to use in any queries and submissions. The format is <code>"application-version"</code>, where application is your application's name and version is a version number which may not contain a '-' character. </td></tr> <tr><td class="paramname">Server</td><td>Server to be used (defaults to musicbrainz.org if not specified) </td></tr> <tr><td class="paramname">Port</td><td>Port to use (defaults to 80 if not specified) </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a5815d813ce48500b2996b4139278ee08"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">MusicBrainz5::CQuery::~CQuery </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a66e86c0428ac7cb26f3f14522eed046b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool MusicBrainz5::CQuery::AddCollectionEntries </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>CollectionID</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::vector< std::string > & </td> <td class="paramname"><em>Entries</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Add a list of releases to the specified collection.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">CollectionID</td><td>The MusicBrainz ID of the collection to add entries to </td></tr> <tr><td class="paramname">Entries</td><td>List of MusicBrainz Release IDs to add to the collection</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true if successful, false otherwise</dd></dl> <dl class="exception"><dt>Exceptions</dt><dd> <table class="exception"> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_connection_error.html" title="Exception thrown when an error occurs connecting to web service.">CConnectionError</a></td><td>An error occurred connecting to the web server </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_timeout_error.html" title="Exception thrown when a connection to the web service times out.">CTimeoutError</a></td><td>A timeout occurred when connecting to the web server </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_authentication_error.html" title="Exception thrown when an authentication error occurs.">CAuthenticationError</a></td><td>An authentication error occurred </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_fetch_error.html" title="Exception thrown when an error occurs fetching data.">CFetchError</a></td><td>An error occurred fetching data </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_request_error.html" title="Exception thrown when an invalid request is made.">CRequestError</a></td><td>The request was invalid </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_resource_not_found_error.html" title="Exception thrown when the requested resource is not found.">CResourceNotFoundError</a></td><td>The requested resource was not found </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ab9675feb17771c28ef4c57e318fa09f1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool MusicBrainz5::CQuery::DeleteCollectionEntries </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>CollectionID</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::vector< std::string > & </td> <td class="paramname"><em>Entries</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Delete a list of releases from the specified collection.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">CollectionID</td><td>The MusicBrainz ID of the collection to delete entries from </td></tr> <tr><td class="paramname">Entries</td><td>List of MusicBrainz Release IDs to delete from the collection</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>true if successful, false otherwise</dd></dl> <dl class="exception"><dt>Exceptions</dt><dd> <table class="exception"> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_connection_error.html" title="Exception thrown when an error occurs connecting to web service.">CConnectionError</a></td><td>An error occurred connecting to the web server </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_timeout_error.html" title="Exception thrown when a connection to the web service times out.">CTimeoutError</a></td><td>A timeout occurred when connecting to the web server </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_authentication_error.html" title="Exception thrown when an authentication error occurs.">CAuthenticationError</a></td><td>An authentication error occurred </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_fetch_error.html" title="Exception thrown when an error occurs fetching data.">CFetchError</a></td><td>An error occurred fetching data </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_request_error.html" title="Exception thrown when an invalid request is made.">CRequestError</a></td><td>The request was invalid </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_resource_not_found_error.html" title="Exception thrown when the requested resource is not found.">CResourceNotFoundError</a></td><td>The requested resource was not found </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="abfffd654b4c4d56dfa4f032a9904de66"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string MusicBrainz5::CQuery::LastErrorMessage </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Return the error message from the last query</p> <dl class="section return"><dt>Returns</dt><dd>Error message from last query </dd></dl> </div> </div> <a class="anchor" id="a73bdf9c1c3799fb190f30d7ce58a8fef"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int MusicBrainz5::CQuery::LastHTTPCode </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Return the HTTP code of the last query</p> <dl class="section return"><dt>Returns</dt><dd>HTTP code of last query </dd></dl> </div> </div> <a class="anchor" id="a0d82316a3b5468bd63cb97c5c018fab3"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz5_1_1_c_query.html#aae350311e3035fc9e6dbe9262bd4e6a5">CQuery::tQueryResult</a> MusicBrainz5::CQuery::LastResult </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Return the result of the last query</p> <dl class="section return"><dt>Returns</dt><dd>Result of last query </dd></dl> </div> </div> <a class="anchor" id="ac7a58a495fabb8f1100c101730cf44d4"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="namespace_music_brainz5.html#ab4da2dc2496a9cd019d8383e985a9a6b">CReleaseList</a> MusicBrainz5::CQuery::LookupDiscID </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>DiscID</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Request a list of releases matching the specified disc ID.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">DiscID</td><td>Disc id to match</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="namespace_music_brainz5.html#ab4da2dc2496a9cd019d8383e985a9a6b">MusicBrainz5::CReleaseList</a> </dd></dl> </div> </div> <a class="anchor" id="a20f37001e88266b85cf7b8b5c9c5ccb5"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz5_1_1_c_release.html">CRelease</a> MusicBrainz5::CQuery::LookupRelease </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>ReleaseID</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Query for detailed information about a specific release</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ReleaseID</td><td>MusicBrainz release ID to lookup</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>MusicBrainz::CRelease object</dd></dl> <dl class="exception"><dt>Exceptions</dt><dd> <table class="exception"> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_connection_error.html" title="Exception thrown when an error occurs connecting to web service.">CConnectionError</a></td><td>An error occurred connecting to the web server </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_timeout_error.html" title="Exception thrown when a connection to the web service times out.">CTimeoutError</a></td><td>A timeout occurred when connecting to the web server </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_authentication_error.html" title="Exception thrown when an authentication error occurs.">CAuthenticationError</a></td><td>An authentication error occurred </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_fetch_error.html" title="Exception thrown when an error occurs fetching data.">CFetchError</a></td><td>An error occurred fetching data </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_request_error.html" title="Exception thrown when an invalid request is made.">CRequestError</a></td><td>The request was invalid </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_resource_not_found_error.html" title="Exception thrown when the requested resource is not found.">CResourceNotFoundError</a></td><td>The requested resource was not found </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="abe151c7483ac026df73bd76c23d9b9dd"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz5_1_1_c_metadata.html">CMetadata</a> MusicBrainz5::CQuery::Query </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>Entity</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>ID</em> = <code>""</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>Resource</em> = <code>""</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="class_music_brainz5_1_1_c_query.html#a836013cd0d3870936e0a95fed7434968">tParamMap</a> & </td> <td class="paramname"><em>Params</em> = <code><a class="el" href="class_music_brainz5_1_1_c_query.html#a836013cd0d3870936e0a95fed7434968">tParamMap</a>()</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Performs a generic query.</p> <p>Assuming the following parameters are set:</p> <p>"param1" = "p1v1 p1v2 p1v3"<br/> "param2" = "p2v1"<br/> "param3" = ""<br/> </p> <p>The following query will be generated:</p> <p>/ws/2/Entity/ID/Resource?param1=p1v1+p1v2+p1v3&param2=p2v1&param3</p> <p>If any of ID or Resource are empty, those components will be omitted from the query.</p> <p>For full details about generating queries, see the <a href="http://musicbrainz.org/doc/XML_Web_Service/Version_2" target="_blank">web service</a> documentation.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">Entity</td><td>Entity to lookup (e.g. artist, release, discid) </td></tr> <tr><td class="paramname">ID</td><td>The MusicBrainz ID of the entity </td></tr> <tr><td class="paramname">Resource</td><td>The resource (currently only used for collections) </td></tr> <tr><td class="paramname">Params</td><td>Map of parameters to add to the query (e.g. inc)</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_music_brainz5_1_1_c_metadata.html">MusicBrainz5::CMetadata</a> object</dd></dl> <dl class="exception"><dt>Exceptions</dt><dd> <table class="exception"> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_connection_error.html" title="Exception thrown when an error occurs connecting to web service.">CConnectionError</a></td><td>An error occurred connecting to the web server </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_timeout_error.html" title="Exception thrown when a connection to the web service times out.">CTimeoutError</a></td><td>A timeout occurred when connecting to the web server </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_authentication_error.html" title="Exception thrown when an authentication error occurs.">CAuthenticationError</a></td><td>An authentication error occurred </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_fetch_error.html" title="Exception thrown when an error occurs fetching data.">CFetchError</a></td><td>An error occurred fetching data </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_request_error.html" title="Exception thrown when an invalid request is made.">CRequestError</a></td><td>The request was invalid </td></tr> <tr><td class="paramname"><a class="el" href="class_music_brainz5_1_1_c_resource_not_found_error.html" title="Exception thrown when the requested resource is not found.">CResourceNotFoundError</a></td><td>The requested resource was not found </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a093a951cf3a09e8459d0709ecf66c0fc"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void MusicBrainz5::CQuery::SetPassword </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>Password</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Set the password to use when authenticating to the MusicBrainz service</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">Password</td><td>Password to use </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ab237049b014dc5328ebed3f27d33bda2"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void MusicBrainz5::CQuery::SetProxyHost </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>ProxyHost</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Set the proxy server to use for queries. <b>Note</b> The http_proxy environment variable will be used to set a 'default' proxy server. Calls to this method will override any proxy settings set by the http_proxy environment variable.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ProxyHost</td><td>Proxy server to use </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ae8c3f30511c5c338eb9f054c214c4e1f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void MusicBrainz5::CQuery::SetProxyPassword </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>ProxyPassword</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Set the password to use when authenticating to the proxy server. <b>Note</b> The http_proxy environment variable will be used to set a 'default' proxy server. Calls to this method will override any proxy settings set by the http_proxy environment variable.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ProxyPassword</td><td>Proxy password to use </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a76aec7e307ebb5b0f0c2435b8a3eb43e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void MusicBrainz5::CQuery::SetProxyPort </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>ProxyPort</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Set the proxy server port to use for queries. <b>Note</b> The http_proxy environment variable will be used to set a 'default' proxy server. Calls to this method will override any proxy settings set by the http_proxy environment variable.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ProxyPort</td><td>Proxy port to use </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a87cdf7899544d6fbb3a6263010780d54"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void MusicBrainz5::CQuery::SetProxyUserName </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>ProxyUserName</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Set the user name to use when authenticating to the proxy server. <b>Note</b> The http_proxy environment variable will be used to set a 'default' proxy server. Calls to this method will override any proxy settings set by the http_proxy environment variable.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ProxyUserName</td><td>Proxy user name to use </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ad8cbaf48b4ecfb227642d78181fd9948"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void MusicBrainz5::CQuery::SetUserName </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>UserName</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Set the user name to use when authenticating to the MusicBrainz service</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">UserName</td><td>Username to use </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a0559681143d4ef8af8b96ba42b75590f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::string MusicBrainz5::CQuery::Version </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Return the library version</p> <dl class="section return"><dt>Returns</dt><dd>Library version </dd></dl> </div> </div> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="namespace_music_brainz5.html">MusicBrainz5</a></li><li class="navelem"><a class="el" href="class_music_brainz5_1_1_c_query.html">CQuery</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3.1 </li> </ul> </div> </body> </html>