ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_gaea8d7735d41853167a2befdc06febe43.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_Init</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___i_n_i_t___a_n_d___s_r_v.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="gaea8d7735d41853167a2befdc06febe43"></a>
  92 <div class="memitem">
  93 <div class="memproto">
  94       <table class="memname">
  95         <tr>
  96           <td class="memname"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga886138f5d13e84ffaa3df5769830e1cd.html#ga886138f5d13e84ffaa3df5769830e1cd">Ucs_Return_t</a> Ucs_Init </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">const <a class="el" href="struct_ucs___init_data__t.html">Ucs_InitData_t</a> *&#160;</td>
 105           <td class="paramname"><em>init_ptr</em>, </td>
 106         </tr>
 107         <tr>
 108           <td class="paramkey"></td>
 109           <td></td>
 110           <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_gaba3a47e6c1d360c77e560cefe8c541e3.html#gaba3a47e6c1d360c77e560cefe8c541e3">Ucs_InitResultCb_t</a>&#160;</td>
 111           <td class="paramname"><em>init_result_fptr</em>&#160;</td>
 112         </tr>
 113         <tr>
 114           <td></td>
 115           <td>)</td>
 116           <td></td><td></td>
 117         </tr>
 118       </table>
 119 </div><div class="memdoc">
 120
 121 <p>UNICENS initialization function. </p>
 122 <p>This function must be called by the application for initializing the complete MOST NetServices library. </p>
 123 <dl class="section note"><dt>Note</dt><dd><b>Do not call this function within any of the UNICENS callbacks!</b> </dd></dl>
 124 <dl class="params"><dt>Parameters</dt><dd>
 125   <table class="params">
 126     <tr><td class="paramname">self</td><td>The instance </td></tr>
 127     <tr><td class="paramname">init_ptr</td><td>Reference to UNICENS initialization data </td></tr>
 128     <tr><td class="paramname">init_result_fptr</td><td>Callback that reports the result of the initialization Possible result values are shown in the table below. <table class="doxtable">
 129 <tr>
 130 <th>Result Code </th><th>Description</th></tr>
 131 <tr>
 132 <td>UCS_INIT_RES_SUCCESS </td><td>Initialization succeeded </td></tr>
 133 <tr>
 134 <td>UCS_INIT_RES_ERR_BUF_OVERFLOW </td><td>No message buffer available </td></tr>
 135 <tr>
 136 <td>UCS_INIT_RES_ERR_PMS_INIT </td><td>PMS cannot establish INIC synchronization within 2 seconds </td></tr>
 137 <tr>
 138 <td>UCS_INIT_RES_ERR_INIC_VERSION </td><td>INIC device version check failed </td></tr>
 139 <tr>
 140 <td>UCS_INIT_RES_ERR_DEV_ATT_CFG </td><td>Device attach failed due to an configuration error </td></tr>
 141 <tr>
 142 <td>UCS_INIT_RES_ERR_DEV_ATT_PROC </td><td>Device attach failed due to a system error </td></tr>
 143 <tr>
 144 <td>UCS_INIT_RES_ERR_NET_CFG </td><td>Network configuration failed </td></tr>
 145 <tr>
 146 <td>UCS_INIT_RES_ERR_TIMEOUT </td><td>Initialization was not successful within 2 seconds </td></tr>
 147 </table>
 148 </td></tr>
 149   </table>
 150   </dd>
 151 </dl>
 152 <dl class="section return"><dt>Returns</dt><dd>Possible return values are shown in the table below. <table class="doxtable">
 153 <tr>
 154 <th>Value </th><th>Description</th></tr>
 155 <tr>
 156 <td>UCS_RET_SUCCESS </td><td>No error. </td></tr>
 157 <tr>
 158 <td>UCS_RET_ERR_PARAM </td><td>Parameter <code>init_ptr</code> or one of its attributes is not set correctly. </td></tr>
 159 </table>
 160 </dd></dl>
 161
 162 </div>
 163 </div>
 164 </div><!-- contents -->
 165 </div><!-- doc-content -->
 166 <!-- start footer part -->
 167 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 168   <ul>
 169     <li class="navelem"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v.html">Initialization and Service</a></li>
 170     <li class="footer">&copy; 2017 Microchip Technology Inc. All rights reserved. <a href="http://www.microchip.com" target="_blank">www.microchip.com</a></li>
 171   </ul>
 172 </div>
 173 </body>
 174 <!--
 175 Generated on Mon Apr 3 2017 13:52:59 for UNICENS by
 176 Doxygen 1.8.2
 177 -->
 178 <script language="javascript">
 179 <!--
 180 $('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>');
 181 -->
 182 </script>
 183 </html>