Newer
Older
ubix2 / doc / html / lists_8h.html
@reddawg reddawg on 5 Dec 2006 20 KB Documentation
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>UbixOS V2: src/sys/include/ubixos/lists.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
  <ul>
    <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
    <li id="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="dirs.html"><span>Directories</span></a></li>
    <li>
      <form action="search.php" method="get">
        <table cellspacing="0" cellpadding="0" border="0">
          <tr>
            <td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
            <td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
          </tr>
        </table>
      </form>
    </li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
    <li><a href="globals.html"><span>Globals</span></a></li>
  </ul></div>
<div class="nav">
<a class="el" href="dir_897b6a2d7bab147dd1db58381aad3984.html">src</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_832905b1f7f5feaf61a306b40c0ac817.html">sys</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_caf4200c438ae9601464168e21e8e4d8.html">include</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_9854bc9d2b9a2a73f32c73e97d31d0f7.html">ubixos</a></div>
<h1>lists.h File Reference</h1>
<p>

<p>
<a href="lists_8h-source.html">Go to the source code of this file.</a><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 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__item__t.html">_item_t</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__list__t.html">_list_t</a></td></tr>

<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lists_8h.html#c2bbd6d630a06a980d9a92ddb9a49928">IN</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lists_8h.html#0c8bc59048468b4c3eca7ce84d192dea">STATUS_FAILURE</a>&nbsp;&nbsp;&nbsp;-1</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lists_8h.html#e56fdb340b23940f7a64ed2e37c1774a">STATUS_SUCCESS</a>&nbsp;&nbsp;&nbsp;0</td></tr>

<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="struct__item__t.html">_item_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lists_8h.html#4c2a982479f3f5d39102321f3408ca90">Item_t</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="struct__list__t.html">_list_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lists_8h.html#680544a1203d80169f21f458fecfe884">List_t</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__item__t.html">Item_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lists_8h.html#ddb302e5cc32ff6fd65b02523e648764">CreateItem</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lists_8h.html#b9a0d179b5e55b53a8a8986f0fe0cc28">DestroyItemList</a> (IN <a class="el" href="struct__list__t.html">List_t</a> *ItemList)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lists_8h.html#10fa3fb36bc18b5b9f32d1e6341a8d29">DestroyItemsInList</a> (IN <a class="el" href="struct__list__t.html">List_t</a> *ItemList)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct__item__t.html">Item_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lists_8h.html#e11b6e9329a773700914a6fe979fdcd0">GetFirstItem</a> (IN <a class="el" href="struct__list__t.html">List_t</a> *kItem)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct__item__t.html">Item_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lists_8h.html#00330d853767d9e546684615f4aeac36">GetLastItem</a> (IN <a class="el" href="struct__list__t.html">List_t</a> *kItem)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct__list__t.html">List_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lists_8h.html#5f388b13396e1961b2a85720edf33712">InitializeList</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lists_8h.html#17a1ba9fdeb8b898fdcf68f8eb2ff74c">InsertItemAtFront</a> (IN <a class="el" href="struct__list__t.html">List_t</a> *TList, IN <a class="el" href="struct__item__t.html">Item_t</a> *kItem)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lists_8h.html#0ae565e4f2d5d2fa10e55a3aaca74a75">InsertItemBetweenItems</a> (IN <a class="el" href="struct__list__t.html">List_t</a> *TList, IN <a class="el" href="struct__item__t.html">Item_t</a> *Previous, IN <a class="el" href="struct__item__t.html">Item_t</a> *Next, IN <a class="el" href="struct__item__t.html">Item_t</a> *Insert)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lists_8h.html#44a2d924a34492e8401409ea5f11891c">InsertItemListBetweenItems</a> (IN <a class="el" href="struct__item__t.html">Item_t</a> *Previous, IN <a class="el" href="struct__item__t.html">Item_t</a> *Next, IN <a class="el" href="struct__list__t.html">List_t</a> *Insert)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lists_8h.html#2b9e1632567024deb03a7b0a5d04f890">RemoveItem</a> (IN <a class="el" href="struct__list__t.html">List_t</a> *TList, IN <a class="el" href="struct__item__t.html">Item_t</a> *kItem)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct__list__t.html">List_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lists_8h.html#321d74ff1e6cfbfa8bea8a0f1a79f2df">RemoveItemListBetweenItems</a> (IN <a class="el" href="struct__item__t.html">Item_t</a> *Previous, IN <a class="el" href="struct__item__t.html">Item_t</a> *Next)</td></tr>

</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="c2bbd6d630a06a980d9a92ddb9a49928"></a><!-- doxytag: member="lists.h::IN" ref="c2bbd6d630a06a980d9a92ddb9a49928" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define IN          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>
Definition at line <a class="el" href="lists_8h-source.html#l00001">1</a> of file <a class="el" href="lists_8h-source.html">lists.h</a>.
</div>
</div><p>
<a class="anchor" name="0c8bc59048468b4c3eca7ce84d192dea"></a><!-- doxytag: member="lists.h::STATUS_FAILURE" ref="0c8bc59048468b4c3eca7ce84d192dea" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define STATUS_FAILURE&nbsp;&nbsp;&nbsp;-1          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>
Definition at line <a class="el" href="lists_8h-source.html#l00002">2</a> of file <a class="el" href="lists_8h-source.html">lists.h</a>.
</div>
</div><p>
<a class="anchor" name="e56fdb340b23940f7a64ed2e37c1774a"></a><!-- doxytag: member="lists.h::STATUS_SUCCESS" ref="e56fdb340b23940f7a64ed2e37c1774a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define STATUS_SUCCESS&nbsp;&nbsp;&nbsp;0          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>
Definition at line <a class="el" href="lists_8h-source.html#l00003">3</a> of file <a class="el" href="lists_8h-source.html">lists.h</a>.
</div>
</div><p>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="4c2a982479f3f5d39102321f3408ca90"></a><!-- doxytag: member="lists.h::Item_t" ref="4c2a982479f3f5d39102321f3408ca90" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="struct__item__t.html">_item_t</a> <a class="el" href="struct__item__t.html">Item_t</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>
Definition at line <a class="el" href="lists_8h-source.html#l00005">5</a> of file <a class="el" href="lists_8h-source.html">lists.h</a>.
</div>
</div><p>
<a class="anchor" name="680544a1203d80169f21f458fecfe884"></a><!-- doxytag: member="lists.h::List_t" ref="680544a1203d80169f21f458fecfe884" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="struct__list__t.html">_list_t</a> <a class="el" href="struct__list__t.html">List_t</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>
Definition at line <a class="el" href="lists_8h-source.html#l00006">6</a> of file <a class="el" href="lists_8h-source.html">lists.h</a>.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="ddb302e5cc32ff6fd65b02523e648764"></a><!-- doxytag: member="lists.h::CreateItem" ref="ddb302e5cc32ff6fd65b02523e648764" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct__item__t.html">Item_t</a>* CreateItem           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>
Referenced by <a class="el" href="kmod_8c-source.html#l00046">kmod_add()</a>.
</div>
</div><p>
<a class="anchor" name="b9a0d179b5e55b53a8a8986f0fe0cc28"></a><!-- doxytag: member="lists.h::DestroyItemList" ref="b9a0d179b5e55b53a8a8986f0fe0cc28" args="(IN List_t *ItemList)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int DestroyItemList           </td>
          <td>(</td>
          <td class="paramtype">IN <a class="el" href="struct__list__t.html">List_t</a> *&nbsp;</td>
          <td class="paramname"> <em>ItemList</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="10fa3fb36bc18b5b9f32d1e6341a8d29"></a><!-- doxytag: member="lists.h::DestroyItemsInList" ref="10fa3fb36bc18b5b9f32d1e6341a8d29" args="(IN List_t *ItemList)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int DestroyItemsInList           </td>
          <td>(</td>
          <td class="paramtype">IN <a class="el" href="struct__list__t.html">List_t</a> *&nbsp;</td>
          <td class="paramname"> <em>ItemList</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="e11b6e9329a773700914a6fe979fdcd0"></a><!-- doxytag: member="lists.h::GetFirstItem" ref="e11b6e9329a773700914a6fe979fdcd0" args="(IN List_t *kItem)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct__item__t.html">Item_t</a>* GetFirstItem           </td>
          <td>(</td>
          <td class="paramtype">IN <a class="el" href="struct__list__t.html">List_t</a> *&nbsp;</td>
          <td class="paramname"> <em>kItem</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="00330d853767d9e546684615f4aeac36"></a><!-- doxytag: member="lists.h::GetLastItem" ref="00330d853767d9e546684615f4aeac36" args="(IN List_t *kItem)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct__item__t.html">Item_t</a>* GetLastItem           </td>
          <td>(</td>
          <td class="paramtype">IN <a class="el" href="struct__list__t.html">List_t</a> *&nbsp;</td>
          <td class="paramname"> <em>kItem</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="5f388b13396e1961b2a85720edf33712"></a><!-- doxytag: member="lists.h::InitializeList" ref="5f388b13396e1961b2a85720edf33712" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct__list__t.html">List_t</a>* InitializeList           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>
Referenced by <a class="el" href="kmod_8c-source.html#l00046">kmod_add()</a>.
</div>
</div><p>
<a class="anchor" name="17a1ba9fdeb8b898fdcf68f8eb2ff74c"></a><!-- doxytag: member="lists.h::InsertItemAtFront" ref="17a1ba9fdeb8b898fdcf68f8eb2ff74c" args="(IN List_t *TList, IN Item_t *kItem)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int InsertItemAtFront           </td>
          <td>(</td>
          <td class="paramtype">IN <a class="el" href="struct__list__t.html">List_t</a> *&nbsp;</td>
          <td class="paramname"> <em>TList</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN <a class="el" href="struct__item__t.html">Item_t</a> *&nbsp;</td>
          <td class="paramname"> <em>kItem</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>
Referenced by <a class="el" href="kmod_8c-source.html#l00046">kmod_add()</a>.
</div>
</div><p>
<a class="anchor" name="0ae565e4f2d5d2fa10e55a3aaca74a75"></a><!-- doxytag: member="lists.h::InsertItemBetweenItems" ref="0ae565e4f2d5d2fa10e55a3aaca74a75" args="(IN List_t *TList, IN Item_t *Previous, IN Item_t *Next, IN Item_t *Insert)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int InsertItemBetweenItems           </td>
          <td>(</td>
          <td class="paramtype">IN <a class="el" href="struct__list__t.html">List_t</a> *&nbsp;</td>
          <td class="paramname"> <em>TList</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN <a class="el" href="struct__item__t.html">Item_t</a> *&nbsp;</td>
          <td class="paramname"> <em>Previous</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN <a class="el" href="struct__item__t.html">Item_t</a> *&nbsp;</td>
          <td class="paramname"> <em>Next</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN <a class="el" href="struct__item__t.html">Item_t</a> *&nbsp;</td>
          <td class="paramname"> <em>Insert</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="44a2d924a34492e8401409ea5f11891c"></a><!-- doxytag: member="lists.h::InsertItemListBetweenItems" ref="44a2d924a34492e8401409ea5f11891c" args="(IN Item_t *Previous, IN Item_t *Next, IN List_t *Insert)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void InsertItemListBetweenItems           </td>
          <td>(</td>
          <td class="paramtype">IN <a class="el" href="struct__item__t.html">Item_t</a> *&nbsp;</td>
          <td class="paramname"> <em>Previous</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN <a class="el" href="struct__item__t.html">Item_t</a> *&nbsp;</td>
          <td class="paramname"> <em>Next</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN <a class="el" href="struct__list__t.html">List_t</a> *&nbsp;</td>
          <td class="paramname"> <em>Insert</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="2b9e1632567024deb03a7b0a5d04f890"></a><!-- doxytag: member="lists.h::RemoveItem" ref="2b9e1632567024deb03a7b0a5d04f890" args="(IN List_t *TList, IN Item_t *kItem)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int RemoveItem           </td>
          <td>(</td>
          <td class="paramtype">IN <a class="el" href="struct__list__t.html">List_t</a> *&nbsp;</td>
          <td class="paramname"> <em>TList</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN <a class="el" href="struct__item__t.html">Item_t</a> *&nbsp;</td>
          <td class="paramname"> <em>kItem</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="321d74ff1e6cfbfa8bea8a0f1a79f2df"></a><!-- doxytag: member="lists.h::RemoveItemListBetweenItems" ref="321d74ff1e6cfbfa8bea8a0f1a79f2df" args="(IN Item_t *Previous, IN Item_t *Next)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct__list__t.html">List_t</a>* RemoveItemListBetweenItems           </td>
          <td>(</td>
          <td class="paramtype">IN <a class="el" href="struct__item__t.html">Item_t</a> *&nbsp;</td>
          <td class="paramname"> <em>Previous</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IN <a class="el" href="struct__item__t.html">Item_t</a> *&nbsp;</td>
          <td class="paramname"> <em>Next</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Tue Dec 5 09:28:06 2006 for UbixOS V2 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>