diff options
Diffstat (limited to 'ucs2-lib/doc/html/group___g___u_c_s___a_m_s_ga6486fc060d0aa8b1bb34851d2e63b755.html')
| -rw-r--r-- | ucs2-lib/doc/html/group___g___u_c_s___a_m_s_ga6486fc060d0aa8b1bb34851d2e63b755.html | 170 |
1 files changed, 170 insertions, 0 deletions
diff --git a/ucs2-lib/doc/html/group___g___u_c_s___a_m_s_ga6486fc060d0aa8b1bb34851d2e63b755.html b/ucs2-lib/doc/html/group___g___u_c_s___a_m_s_ga6486fc060d0aa8b1bb34851d2e63b755.html new file mode 100644 index 0000000..35fcbce --- /dev/null +++ b/ucs2-lib/doc/html/group___g___u_c_s___a_m_s_ga6486fc060d0aa8b1bb34851d2e63b755.html @@ -0,0 +1,170 @@ +<!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_AmsTx_SendMsg</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___a_m_s.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="ga6486fc060d0aa8b1bb34851d2e63b755"></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_AmsTx_SendMsg </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="struct_ucs___ams_tx___msg__t.html">Ucs_AmsTx_Msg_t</a> * </td> + <td class="paramname"><em>msg_ptr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group___g___u_c_s___a_m_s___t_y_p_e_s_ga60acfdd5b93a99906d751ac2f14623a9.html#ga60acfdd5b93a99906d751ac2f14623a9">Ucs_AmsTx_CompleteCb_t</a> </td> + <td class="paramname"><em>tx_complete_fptr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Transmits an application message. </p> +<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">msg_ptr</td><td>Reference to the related Tx message object </td></tr> + <tr><td class="paramname">tx_complete_fptr</td><td>Callback function that is invoked as soon as the transmission was finished and the transmission result is available. The application must assign a callback function if the transmission result is required or the Tx message object uses external payload which needs to be reused or freed by the application. Otherwise the application is allowed to pass <code>NULL</code>. </td></tr> + </table> + </dd> +</dl> +<dl class="section note"><dt>Note</dt><dd>It is important that <code>msg_ptr</code> is the reference to an object which was previously obtained from <a class="el" href="group___g___u_c_s___a_m_s_gafbcfeaaa6ff3d255609e404b16dbdf0f.html#gafbcfeaaa6ff3d255609e404b16dbdf0f" title="Allocates an application message object for transmission.">Ucs_AmsTx_AllocMsg()</a>. The application must not pass the reference of a <em>self-created</em> Tx message object to this function. </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>Invalid parameter is given. Possible reasons are:<ul> +<li><code>msg_ptr</code> is <code>NULL</code> </li> +<li><code>destination_address</code> is smaller than <code>0x10</code> (reserved for internal communication)</li> +<li><code>data_size</code> of a broad or group-cast message is larger than <code>45</code> </li> +</ul> +Either the application must modify the message and retry the function call, or must free the message object via <a class="el" href="group___g___u_c_s___a_m_s_ga9e03946330dcc4ed4111b1d43714308d.html#ga9e03946330dcc4ed4111b1d43714308d" title="Frees an unused Tx message object.">Ucs_AmsTx_FreeUnusedMsg()</a>. </td></tr> +<tr> +<td>UCS_RET_ERR_NOT_INITIALIZED</td><td>UNICENS is not initialized. <br/> + Message objects that have been allocated during initialized state are no longer valid. </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___a_m_s.html">Application Message 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> |