ucs2-lib/doc/html/group___g___u_c_s___r_o_u_t_i_n_g_ga32d004eb96f434f379614b29fe2a486a.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <title>UNICENS: Ucs_Rm_GetNodeAvailable</title>
   7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   8 <link rel="shortcut icon" type="image/x-icon" href="favicon.ico">
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12 <script type="text/javascript" src="resize.js"></script>
  13 <script type="text/javascript" src="navtree.js"></script>
  14 <script type="text/javascript">
  15   $(document).ready(initResizable);
  16 </script>
  17 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18 <script type="text/javascript" src="search/search.js"></script>
  19 <script type="text/javascript">
  20   $(document).ready(function() { searchBox.OnSelectItem(0); });
  21 </script>
  22 <link href="style_html.css" rel="stylesheet" type="text/css" />
  23 <link href="inic.css" rel="stylesheet" type="text/css"/>
  24 </head>
  25 <body>
  26 <div class="GlobalWrapper">
  27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28 <div id="titlearea">
  29 <table cellspacing="0" cellpadding="0">
  30  <tbody>
  31  <tr>
  32   <td><a href="index.html"><img alt="Logo" src="logo.png"/></a></td>
  33   <td>
  34    <div id="projectname">UNICENS&#160;<span id="projectnumber">V2.1.0-3491</span></div>
  35    <div id="projectbrief">User Manual and API Reference</div>
  36     <div id="searchbox">        <div id="MSearchBox" class="MSearchBoxInactive">
  37         <span class="left">
  38           <img id="MSearchSelect" src="search/mag_sel.png"
  39                onmouseover="return searchBox.OnSearchSelectShow()"
  40                onmouseout="return searchBox.OnSearchSelectHide()"
  41                alt=""/>
  42           <input type="text" id="MSearchField" value="Search" accesskey="S"
  43                onfocus="searchBox.OnSearchFieldFocus(true)"
  44                onblur="searchBox.OnSearchFieldFocus(false)"
  45                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  46           </span><span class="right">
  47             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  48           </span>
  49         </div>
  50 </div>
  51   </td>
  52  </tr>
  53  </tbody>
  54 </table>
  55 </div>
  56 <!-- end header part -->
  57 <!-- Generated by Doxygen 1.8.2 -->
  58 <script type="text/javascript">
  59 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  60 </script>
  61 </div><!-- top -->
  62 <div id="side-nav" class="ui-resizable side-nav-resizable">
  63   <div id="nav-tree">
  64     <div id="nav-tree-contents">
  65       <div id="nav-sync" class="sync"></div>
  66     </div>
  67   </div>
  68   <div id="splitbar" style="-moz-user-select:none;"
  69        class="ui-resizable-handle">
  70   </div>
  71 </div>
  72 <script type="text/javascript">
  73 $(document).ready(function(){initNavTree('group___g___u_c_s___r_o_u_t_i_n_g.html','');});
  74 </script>
  75 <div id="doc-content">
  76 <!-- window showing the filter options -->
  77 <div id="MSearchSelectWindow"
  78      onmouseover="return searchBox.OnSearchSelectShow()"
  79      onmouseout="return searchBox.OnSearchSelectHide()"
  80      onkeydown="return searchBox.OnSearchSelectKey(event)">
  81 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  82
  83 <!-- iframe showing the search results (closed by default) -->
  84 <div id="MSearchResultsWindow">
  85 <iframe src="javascript:void(0)" frameborder="0"
  86         name="MSearchResults" id="MSearchResults">
  87 </iframe>
  88 </div>
  89
  90 <div class="contents">
  91 <a class="anchor" id="ga32d004eb96f434f379614b29fe2a486a"></a>
  92 <div class="memitem">
  93 <div class="memproto">
  94       <table class="memname">
  95         <tr>
  96           <td class="memname">bool Ucs_Rm_GetNodeAvailable </td>
  97           <td>(</td>
  98           <td class="paramtype"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga074c04d40d00986e0c869adaec8fadda.html#ga074c04d40d00986e0c869adaec8fadda">Ucs_Inst_t</a> *&#160;</td>
  99           <td class="paramname"><em>self</em>, </td>
 100         </tr>
 101         <tr>
 102           <td class="paramkey"></td>
 103           <td></td>
 104           <td class="paramtype"><a class="el" href="struct_ucs___rm___node__t.html">Ucs_Rm_Node_t</a> *&#160;</td>
 105           <td class="paramname"><em>node_ptr</em>&#160;</td>
 106         </tr>
 107         <tr>
 108           <td></td>
 109           <td>)</td>
 110           <td></td><td></td>
 111         </tr>
 112       </table>
 113 </div><div class="memdoc">
 114
 115 <p>Retrieves the <code>"available"</code> flag information of the given node. </p>
 116 <p>This function can be used to check whether the given node has been set to <code>"available"</code> or <code>"not available"</code>.</p>
 117 <dl class="params"><dt>Parameters</dt><dd>
 118   <table class="params">
 119     <tr><td class="paramname">self</td><td>The UNICENS instance pointer. </td></tr>
 120     <tr><td class="paramname">node_ptr</td><td>Reference to the node to be looked for. </td></tr>
 121   </table>
 122   </dd>
 123 </dl>
 124 <dl class="section return"><dt>Returns</dt><dd>The <code>"availability"</code> flag of the given node.</dd></dl>
 125 <p><br/>
 126 <br/>
 127 <b>Example</b> </p>
 128 <div class="fragment"><div class="line"><span class="comment">// Main function</span></div>
 129 <div class="line"><span class="keywordtype">void</span> main(uint8_t argc, <span class="keywordtype">char</span> *argv[])</div>
 130 <div class="line">{</div>
 131 <div class="line">    <span class="comment">// ...</span></div>
 132 <div class="line">    <span class="keywordflow">if</span> (<a class="code" href="group___g___u_c_s___r_o_u_t_i_n_g_ga32d004eb96f434f379614b29fe2a486a.html#ga32d004eb96f434f379614b29fe2a486a" title="Retrieves the &quot;available&quot; flag information of the given node.">Ucs_Rm_GetNodeAvailable</a>(ucs_inst_ptr, &amp;slim_mic_node))</div>
 133 <div class="line">    {</div>
 134 <div class="line">        <span class="comment">// Do whatever is necessary to be done</span></div>
 135 <div class="line">    }</div>
 136 <div class="line">}</div>
 137 </div><!-- fragment -->
 138 </div>
 139 </div>
 140 </div><!-- contents -->
 141 </div><!-- doc-content -->
 142 <!-- start footer part -->
 143 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 144   <ul>
 145     <li class="navelem"><a class="el" href="group___g___u_c_s___r_o_u_t_i_n_g.html">Routing Management</a></li>
 146     <li class="footer">&copy; 2017 Microchip Technology Inc. All rights reserved. <a href="http://www.microchip.com" target="_blank">www.microchip.com</a></li>
 147   </ul>
 148 </div>
 149 </body>
 150 <!--
 151 Generated on Mon Apr 3 2017 13:53:00 for UNICENS by
 152 Doxygen 1.8.2
 153 -->
 154 <script language="javascript">
 155 <!--
 156 $('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>');
 157 -->
 158 </script>
 159 </html>