diff options
Diffstat (limited to 'c-layman/doc/html/group__layman__api.html')
| -rw-r--r-- | c-layman/doc/html/group__layman__api.html | 670 |
1 files changed, 670 insertions, 0 deletions
diff --git a/c-layman/doc/html/group__layman__api.html b/c-layman/doc/html/group__layman__api.html new file mode 100644 index 0000000..0e31e6d --- /dev/null +++ b/c-layman/doc/html/group__layman__api.html @@ -0,0 +1,670 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>C-Layman: Layman API</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.5.8 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="modules.html"><span>Modules</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Layman API</h1>Main API functions. +<a href="#_details">More...</a> +<p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a></td></tr> + +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#gc1ae8bdf47eca0cea7bb8e7f3147cded">laymanAPICreate</a> (<a class="el" href="struct_bare_config.html">BareConfig</a> *config, int report_error, int output)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#g565dbbf32dcbaa175bb9d3038c079725">laymanAPIIsRepo</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, const char *repo)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#g9cc093b2c4e423cd16c2b0fb9b5ef3c6">laymanAPIIsInstalled</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, const char *repo)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_string_list.html">StringList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#gb5def5ffed71eadc0b49a826905c30e4">laymanAPIGetAvailable</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, int reload)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_string_list.html">StringList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#g87060319cb5448e8776f5b2b960c12eb">laymanAPIGetInstalled</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, int reload)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#g23f91e7730d5cdd000a53debc6854b10">laymanAPISync</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, const char *overlay, int verbose)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#g8fbe3095011d998bf0bfe8aab46f2009">laymanAPIFetchRemoteList</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#gcdc26d10e9faf847996c3ae3295c48b7">laymanAPIGetInfoStrList</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, <a class="el" href="struct_string_list.html">StringList</a> *overlays, <a class="el" href="struct_overlay_info.html">OverlayInfo</a> *results)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_overlay_info.html">OverlayInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#ge97d530a816f7da28be35eb20a8ab22d">laymanAPIGetInfoStr</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, const char *overlay)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_overlay_info.html">OverlayInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#gf5e1d733f389f845e594c25b99706415">laymanAPIGetAllInfo</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, const char *overlay)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#g2e04f8103171790be61f092078fea8ff">laymanAPIGetAllInfoList</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, <a class="el" href="struct_string_list.html">StringList</a> *overlays, <a class="el" href="struct_overlay_info.html">OverlayInfo</a> *results)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#g8ea2f5e93d017bd0ac40a745d4dc2219">laymanAPIAddRepo</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, const char *repo)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#gb090e78aaf388d85ea79db19991c5e65">laymanAPIAddRepoList</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, <a class="el" href="struct_string_list.html">StringList</a> *repos)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#ge5227c228a1c4a2a18a674bca298c331">laymanAPIDeleteRepo</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, const char *repo)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#g0cd008dbdec709f24a3b88fefdfe3796">laymanAPIDeleteRepoList</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, <a class="el" href="struct_string_list.html">StringList</a> *repos)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#g9babe72a16d6fd80b9f138ca6fb7a379">laymanAPIFree</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#gc9e16e85ef3f86b8f325dcb63e30403f">overlayInfoFree</a> (<a class="el" href="struct_overlay_info.html">OverlayInfo</a> oi)</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Main API functions. <hr><h2>Function Documentation</h2> +<a class="anchor" name="g8ea2f5e93d017bd0ac40a745d4dc2219"></a><!-- doxytag: member="laymanapi.c::laymanAPIAddRepo" ref="g8ea2f5e93d017bd0ac40a745d4dc2219" args="(LaymanAPI *l, const char *repo)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int laymanAPIAddRepo </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td> + <td class="paramname"> <em>l</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>repo</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Adds an overlay to layman<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>repo</em> </td><td>the name of the repository to add</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if it succeeded, False if not </dd></dl> + +</div> +</div><p> +<a class="anchor" name="gb090e78aaf388d85ea79db19991c5e65"></a><!-- doxytag: member="laymanapi.c::laymanAPIAddRepoList" ref="gb090e78aaf388d85ea79db19991c5e65" args="(LaymanAPI *l, StringList *repos)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int laymanAPIAddRepoList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td> + <td class="paramname"> <em>l</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> * </td> + <td class="paramname"> <em>repos</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Adds a list of overlays to layman<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>repo</em> </td><td>the list of the repositories to add</td></tr> + </table> +</dl> +Return True if it succeeded, False if not +</div> +</div><p> +<a class="anchor" name="gc1ae8bdf47eca0cea7bb8e7f3147cded"></a><!-- doxytag: member="laymanapi.c::laymanAPICreate" ref="gc1ae8bdf47eca0cea7bb8e7f3147cded" args="(BareConfig *config, int report_error, int output)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a>* laymanAPICreate </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_bare_config.html">BareConfig</a> * </td> + <td class="paramname"> <em>config</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>report_error</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>output</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Creates a <a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> object that must be used in all function in this file.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>config</em> </td><td>a <a class="el" href="struct_bare_config.html">BareConfig</a> object that contains all configuration options. If NULL, the default configuration will be used. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>report_error</em> </td><td>if True, errors reporting on stdout will be activated. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>? </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>a new instance of the <a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> class, to be freed with <a class="el" href="group__layman__api.html#g9babe72a16d6fd80b9f138ca6fb7a379">laymanAPIFree()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="ge5227c228a1c4a2a18a674bca298c331"></a><!-- doxytag: member="laymanapi.c::laymanAPIDeleteRepo" ref="ge5227c228a1c4a2a18a674bca298c331" args="(LaymanAPI *l, const char *repo)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int laymanAPIDeleteRepo </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td> + <td class="paramname"> <em>l</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>repo</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Deletes an overlay from layman<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>repo</em> </td><td>the name of the repository to delete</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if it succeeded, False if not </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g0cd008dbdec709f24a3b88fefdfe3796"></a><!-- doxytag: member="laymanapi.c::laymanAPIDeleteRepoList" ref="g0cd008dbdec709f24a3b88fefdfe3796" args="(LaymanAPI *l, StringList *repos)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int laymanAPIDeleteRepoList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td> + <td class="paramname"> <em>l</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> * </td> + <td class="paramname"> <em>repos</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 list of overlays from layman<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>repo</em> </td><td>the list of the repositories to delete</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if it succeeded, False if not </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g8fbe3095011d998bf0bfe8aab46f2009"></a><!-- doxytag: member="laymanapi.c::laymanAPIFetchRemoteList" ref="g8fbe3095011d998bf0bfe8aab46f2009" args="(LaymanAPI *l)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int laymanAPIFetchRemoteList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td> + <td class="paramname"> <em>l</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Updates the local overlay list.<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if it succeeded, False if not. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g9babe72a16d6fd80b9f138ca6fb7a379"></a><!-- doxytag: member="laymanapi.c::laymanAPIFree" ref="g9babe72a16d6fd80b9f138ca6fb7a379" args="(LaymanAPI *l)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void laymanAPIFree </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td> + <td class="paramname"> <em>l</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Frees a <a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> object from memory +</div> +</div><p> +<a class="anchor" name="gf5e1d733f389f845e594c25b99706415"></a><!-- doxytag: member="laymanapi.c::laymanAPIGetAllInfo" ref="gf5e1d733f389f845e594c25b99706415" args="(LaymanAPI *l, const char *overlay)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="struct_overlay_info.html">OverlayInfo</a>* laymanAPIGetAllInfo </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td> + <td class="paramname"> <em>l</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>overlay</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get all information from an overlay. This function fills every fields but the text field of the <a class="el" href="struct_overlay_info.html">OverlayInfo</a> structure.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>overlay</em> </td><td>the overlay name to get info from</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>NULL if it fails, an <a class="el" href="struct_overlay_info.html">OverlayInfo</a> struct if not. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g2e04f8103171790be61f092078fea8ff"></a><!-- doxytag: member="laymanapi.c::laymanAPIGetAllInfoList" ref="g2e04f8103171790be61f092078fea8ff" args="(LaymanAPI *l, StringList *overlays, OverlayInfo *results)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int laymanAPIGetAllInfoList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td> + <td class="paramname"> <em>l</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> * </td> + <td class="paramname"> <em>overlays</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_overlay_info.html">OverlayInfo</a> * </td> + <td class="paramname"> <em>results</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Gives a list of OverlayInfo's from the overaly names found in the overlays <a class="el" href="struct_string_list.html">StringList</a>. results must be allocated and initialized with zeroes.<p> +If an information is unavailable (no owner email for example), the correpsonding field will stay to NULL<p> +This function fills every fields but the text field of the <a class="el" href="struct_overlay_info.html">OverlayInfo</a> structure.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>overlays</em> </td><td>the list of overlays to get information from </td></tr> + <tr><td valign="top"></td><td valign="top"><em>results</em> </td><td>a pointer to a table of <a class="el" href="struct_overlay_info.html">OverlayInfo</a> structures</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of <a class="el" href="struct_overlay_info.html">OverlayInfo</a> structures filled. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="gb5def5ffed71eadc0b49a826905c30e4"></a><!-- doxytag: member="laymanapi.c::laymanAPIGetAvailable" ref="gb5def5ffed71eadc0b49a826905c30e4" args="(LaymanAPI *l, int reload)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="struct_string_list.html">StringList</a>* laymanAPIGetAvailable </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td> + <td class="paramname"> <em>l</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>reload</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns a list of the available overlays.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>l</em> </td><td>the <a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> object. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>reload</em> </td><td>if True, reloads the list</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the list of available overlays </dd></dl> + +</div> +</div><p> +<a class="anchor" name="ge97d530a816f7da28be35eb20a8ab22d"></a><!-- doxytag: member="laymanapi.c::laymanAPIGetInfoStr" ref="ge97d530a816f7da28be35eb20a8ab22d" args="(LaymanAPI *l, const char *overlay)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="struct_overlay_info.html">OverlayInfo</a>* laymanAPIGetInfoStr </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td> + <td class="paramname"> <em>l</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>overlay</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Provided for convenience, this function get the information for only 1 overlay.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>overlay</em> </td><td>the overlay name to get info from</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>NULL if it fails, an <a class="el" href="struct_overlay_info.html">OverlayInfo</a> struct if not. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="gcdc26d10e9faf847996c3ae3295c48b7"></a><!-- doxytag: member="laymanapi.c::laymanAPIGetInfoStrList" ref="gcdc26d10e9faf847996c3ae3295c48b7" args="(LaymanAPI *l, StringList *overlays, OverlayInfo *results)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int laymanAPIGetInfoStrList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td> + <td class="paramname"> <em>l</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> * </td> + <td class="paramname"> <em>overlays</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_overlay_info.html">OverlayInfo</a> * </td> + <td class="paramname"> <em>results</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Gets the information from the overlays given in the <a class="el" href="struct_string_list.html">StringList</a> overlays. The results are stored in the results table which must be initialized with N structures, N being the number of overlays in the overlays <a class="el" href="struct_string_list.html">StringList</a>. This function fills the name, text, supported and official fields of the <a class="el" href="struct_overlay_info.html">OverlayInfo</a> structure.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>overlays</em> </td><td>the list of overlays to get information from </td></tr> + <tr><td valign="top"></td><td valign="top"><em>results</em> </td><td>a pointer to a table of <a class="el" href="struct_overlay_info.html">OverlayInfo</a> structures</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of results structures that have been filled </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g87060319cb5448e8776f5b2b960c12eb"></a><!-- doxytag: member="laymanapi.c::laymanAPIGetInstalled" ref="g87060319cb5448e8776f5b2b960c12eb" args="(LaymanAPI *l, int reload)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="struct_string_list.html">StringList</a>* laymanAPIGetInstalled </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td> + <td class="paramname"> <em>l</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>reload</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns a list of the installed overlays.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>l</em> </td><td>the <a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> object. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>reload</em> </td><td>if True, reloads the list</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the list of installed overlays </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g9cc093b2c4e423cd16c2b0fb9b5ef3c6"></a><!-- doxytag: member="laymanapi.c::laymanAPIIsInstalled" ref="g9cc093b2c4e423cd16c2b0fb9b5ef3c6" args="(LaymanAPI *l, const char *repo)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int laymanAPIIsInstalled </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td> + <td class="paramname"> <em>l</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>repo</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Check if the given string is a valid and installed repository<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>l</em> </td><td>the <a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> object. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>repo</em> </td><td>the repository to be checked.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the repository is valid and installed, False if not </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g565dbbf32dcbaa175bb9d3038c079725"></a><!-- doxytag: member="laymanapi.c::laymanAPIIsRepo" ref="g565dbbf32dcbaa175bb9d3038c079725" args="(LaymanAPI *l, const char *repo)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int laymanAPIIsRepo </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td> + <td class="paramname"> <em>l</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>repo</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Check if the given string is a valid repository<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>l</em> </td><td>the <a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> object. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>repo</em> </td><td>the repository to be checked.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the repository is valid, False if not </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g23f91e7730d5cdd000a53debc6854b10"></a><!-- doxytag: member="laymanapi.c::laymanAPISync" ref="g23f91e7730d5cdd000a53debc6854b10" args="(LaymanAPI *l, const char *overlay, int verbose)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int laymanAPISync </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td> + <td class="paramname"> <em>l</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>overlay</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>verbose</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Syncs an overlay.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>overlay</em> </td><td>The name of the overlay to sync </td></tr> + <tr><td valign="top"></td><td valign="top"><em>verbose</em> </td><td>if True, the output will be more verbose.</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if it succeeded, False if not. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="gc9e16e85ef3f86b8f325dcb63e30403f"></a><!-- doxytag: member="laymanapi.c::overlayInfoFree" ref="gc9e16e85ef3f86b8f325dcb63e30403f" args="(OverlayInfo oi)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void overlayInfoFree </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_overlay_info.html">OverlayInfo</a> </td> + <td class="paramname"> <em>oi</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Fri Aug 6 20:00:53 2010 for C-Layman by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> +</body> +</html> |