ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga886138f5d13e84ffaa3df5769830e1cd.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_Return_t</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___t_y_p_e_s.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="ga886138f5d13e84ffaa3df5769830e1cd"></a>
  92 <div class="memitem">
  93 <div class="memproto">
  94       <table class="memname">
  95         <tr>
  96           <td class="memname">enum <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></td>
  97         </tr>
  98       </table>
  99 </div><div class="memdoc">
 100
 101 <p>Standard return codes used for synchronous response. </p>
 102 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
 103 <tr><td valign="top"><em><a class="anchor" id="gga886138f5d13e84ffaa3df5769830e1cda3fb51656e17ee4802f23706f35e349bc"></a>UCS_RET_SUCCESS</em>&nbsp;</td><td>
 104 <p>Operation successfully completed. </p>
 105 </td></tr>
 106 <tr><td valign="top"><em><a class="anchor" id="gga886138f5d13e84ffaa3df5769830e1cdab98b74c51324859f3138fed96afd1573"></a>UCS_RET_ERR_PARAM</em>&nbsp;</td><td>
 107 <p>At least one parameter exceeds its admissible range. </p>
 108 </td></tr>
 109 <tr><td valign="top"><em><a class="anchor" id="gga886138f5d13e84ffaa3df5769830e1cdabb64ac46e62c58382dc65f3fd7bf12d2"></a>UCS_RET_ERR_BUFFER_OVERFLOW</em>&nbsp;</td><td>
 110 <p>Buffer overflow or service busy. </p>
 111 </td></tr>
 112 <tr><td valign="top"><em><a class="anchor" id="gga886138f5d13e84ffaa3df5769830e1cda7e6114552879861375322bf68dafe3a3"></a>UCS_RET_ERR_NOT_AVAILABLE</em>&nbsp;</td><td>
 113 <p>Functionality not available. </p>
 114 </td></tr>
 115 <tr><td valign="top"><em><a class="anchor" id="gga886138f5d13e84ffaa3df5769830e1cda8820168a0730173889011958189733e2"></a>UCS_RET_ERR_NOT_SUPPORTED</em>&nbsp;</td><td>
 116 <p>This function is not supported by this derivative of INIC / physical layer / MOST speed. </p>
 117 </td></tr>
 118 <tr><td valign="top"><em><a class="anchor" id="gga886138f5d13e84ffaa3df5769830e1cda6384d8a38b3298f50efd7bd42a60a2ec"></a>UCS_RET_ERR_INVALID_SHADOW</em>&nbsp;</td><td>
 119 <p>The requested information is not yet available. </p>
 120 </td></tr>
 121 <tr><td valign="top"><em><a class="anchor" id="gga886138f5d13e84ffaa3df5769830e1cda6e3654d081184da037670c8af1950ea7"></a>UCS_RET_ERR_ALREADY_SET</em>&nbsp;</td><td>
 122 <p>The value to be set is already set. The application can therefore be aware that no message will be send to INIC and no callback will be called. </p>
 123 </td></tr>
 124 <tr><td valign="top"><em><a class="anchor" id="gga886138f5d13e84ffaa3df5769830e1cdad4a30091202638c890abbdb682ca4fe5"></a>UCS_RET_ERR_API_LOCKED</em>&nbsp;</td><td>
 125 <p>INIC performs already requested function. </p>
 126 </td></tr>
 127 <tr><td valign="top"><em><a class="anchor" id="gga886138f5d13e84ffaa3df5769830e1cda9e2acee4f83d89585e959b143b7aafb8"></a>UCS_RET_ERR_NOT_INITIALIZED</em>&nbsp;</td><td>
 128 <p>UNICENS is not initialized. </p>
 129 </td></tr>
 130 </table>
 131 </dd>
 132 </dl>
 133
 134 </div>
 135 </div>
 136 </div><!-- contents -->
 137 </div><!-- doc-content -->
 138 <!-- start footer part -->
 139 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 140   <ul>
 141     <li class="navelem"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s.html">Initialization and Service Types</a></li>
 142     <li class="footer">&copy; 2017 Microchip Technology Inc. All rights reserved. <a href="http://www.microchip.com" target="_blank">www.microchip.com</a></li>
 143   </ul>
 144 </div>
 145 </body>
 146 <!--
 147 Generated on Mon Apr 3 2017 13:52:59 for UNICENS by
 148 Doxygen 1.8.2
 149 -->
 150 <script language="javascript">
 151 <!--
 152 $('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>');
 153 -->
 154 </script>
 155 </html>