diff options
Diffstat (limited to 'ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga61381bd30fb6630b6c5d6ecc8968e983.html')
| -rw-r--r-- | ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga61381bd30fb6630b6c5d6ecc8968e983.html | 168 |
1 files changed, 0 insertions, 168 deletions
diff --git a/ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga61381bd30fb6630b6c5d6ecc8968e983.html b/ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga61381bd30fb6630b6c5d6ecc8968e983.html deleted file mode 100644 index 44a82a8..0000000 --- a/ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga61381bd30fb6630b6c5d6ecc8968e983.html +++ /dev/null @@ -1,168 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> -<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<meta http-equiv="X-UA-Compatible" content="IE=9"/> -<title>UNICENS: Ucs_Stop</title> -<link href="tabs.css" rel="stylesheet" type="text/css"/> -<link rel="shortcut icon" type="image/x-icon" href="favicon.ico"> -<script type="text/javascript" src="jquery.js"></script> -<script type="text/javascript" src="dynsections.js"></script> -<link href="navtree.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="resize.js"></script> -<script type="text/javascript" src="navtree.js"></script> -<script type="text/javascript"> - $(document).ready(initResizable); -</script> -<link href="search/search.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="search/search.js"></script> -<script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); -</script> -<link href="style_html.css" rel="stylesheet" type="text/css" /> -<link href="inic.css" rel="stylesheet" type="text/css"/> -</head> -<body> -<div class="GlobalWrapper"> -<div id="top"><!-- do not remove this div, it is closed by doxygen! --> -<div id="titlearea"> -<table cellspacing="0" cellpadding="0"> - <tbody> - <tr> - <td><a href="index.html"><img alt="Logo" src="logo.png"/></a></td> - <td> - <div id="projectname">UNICENS <span id="projectnumber">V2.1.0-3491</span></div> - <div id="projectbrief">User Manual and API Reference</div> - <div id="searchbox"> <div id="MSearchBox" class="MSearchBoxInactive"> - <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - </span><span class="right"> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> - </span> - </div> -</div> - </td> - </tr> - </tbody> -</table> -</div> -<!-- end header part --> -<!-- Generated by Doxygen 1.8.2 --> -<script type="text/javascript"> -var searchBox = new SearchBox("searchBox", "search",false,'Search'); -</script> -</div><!-- top --> -<div id="side-nav" class="ui-resizable side-nav-resizable"> - <div id="nav-tree"> - <div id="nav-tree-contents"> - <div id="nav-sync" class="sync"></div> - </div> - </div> - <div id="splitbar" style="-moz-user-select:none;" - class="ui-resizable-handle"> - </div> -</div> -<script type="text/javascript"> -$(document).ready(function(){initNavTree('group___g___u_c_s___i_n_i_t___a_n_d___s_r_v.html','');}); -</script> -<div id="doc-content"> -<!-- window showing the filter options --> -<div id="MSearchSelectWindow" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - onkeydown="return searchBox.OnSearchSelectKey(event)"> -<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></div> - -<!-- iframe showing the search results (closed by default) --> -<div id="MSearchResultsWindow"> -<iframe src="javascript:void(0)" frameborder="0" - name="MSearchResults" id="MSearchResults"> -</iframe> -</div> - -<div class="contents"> -<a class="anchor" id="ga61381bd30fb6630b6c5d6ecc8968e983"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <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_Stop </td> - <td>(</td> - <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> * </td> - <td class="paramname"><em>self</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <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_gaa573fbe79f76f263a17e51d6de99036d.html#gaa573fbe79f76f263a17e51d6de99036d">Ucs_StdResultCb_t</a> </td> - <td class="paramname"><em>stopped_fptr</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Terminates the execution of UNICENS. </p> -<p>This function stops further communication with the INIC, forces the INIC to protected mode and releases external resources, e.g. calls <code>tx_complete_fptr</code> for previously transmitted application messages. After the termination is complete UNICENS will call stopped_fptr() and will no longer invoke the request_service_fptr. <br/> -<br/> - The application shall no longer call any API function. Any previously retrieved UNICENS objects (e.g. messages) become invalid. </p> -<dl class="section note"><dt>Note</dt><dd><b>Do not call this function within any of the UNICENS callbacks!</b> </dd></dl> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">self</td><td>The instance </td></tr> - <tr><td class="paramname">stopped_fptr</td><td>Mandatory callback function which is invoked as soon as the termination has been completed. Possible result values are shown in the table below. <table class="doxtable"> -<tr> -<th>Result Code </th><th>Description</th></tr> -<tr> -<td>UCS_RES_SUCCESS </td><td>Termination succeeded </td></tr> -<tr> -<td>UCS_RES_ERR_TIMEOUT </td><td>The termination was forced after a definite time. A communication error or INIC reset may be the reason. </td></tr> -</table> -</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Possible return values are shown in the table below. <table class="doxtable"> -<tr> -<th>Value </th><th>Description</th></tr> -<tr> -<td>UCS_RET_SUCCESS </td><td>No error </td></tr> -<tr> -<td>UCS_RET_ERR_PARAM </td><td>Mandatory callback function not provided </td></tr> -<tr> -<td>UCS_RET_ERR_API_LOCKED </td><td>Initialization was not completed or termination has been started before </td></tr> -</table> -</dd></dl> - -</div> -</div> -</div><!-- contents --> -</div><!-- doc-content --> -<!-- start footer part --> -<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> - <ul> - <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> - <li class="footer">© 2017 Microchip Technology Inc. All rights reserved. <a href="http://www.microchip.com" target="_blank">www.microchip.com</a></li> - </ul> -</div> -</body> -<!-- -Generated on Mon Apr 3 2017 13:52:59 for UNICENS by -Doxygen 1.8.2 ---> -<script language="javascript"> -<!-- -$('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>'); ---> -</script> -</html> |