ucs2-lib/doc/html/group___g___u_c_s___s_c_r_i_p_t_i_n_g.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: Node Scripting</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___s_c_r_i_p_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="header">
  91   <div class="summary">
  92 <a href="#nested-classes">Data Structures</a> &#124;
  93 <a href="#typedef-members">Callback Functions</a> &#124;
  94 <a href="#enum-members">Enumerations</a> &#124;
  95 <a href="#func-members">Functions</a>  </div>
  96   <div class="headertitle">
  97 <div class="title">Node Scripting</div>  </div>
  98 </div><!--header-->
  99 <div class="contents">
 100
 101 <p>Provides service function to allow execution of custom scripts in remote Nodes.
 102 <a href="#details">More...</a></p>
 103 <table class="memberdecls">
 104 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
 105 Data Structures</h2></td></tr>
 106 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ucs___ns___config_msg__t.html">Ucs_Ns_ConfigMsg_t</a></td></tr>
 107 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure of a ConfigMsg used in Node-Script.  <a href="struct_ucs___ns___config_msg__t.html#details">More...</a><br/></td></tr>
 108 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 109 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ucs___ns___script__t.html">Ucs_Ns_Script_t</a></td></tr>
 110 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure of a node-script used to configure a remote node.  <a href="struct_ucs___ns___script__t.html#details">More...</a><br/></td></tr>
 111 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 112 </table><table class="memberdecls">
 113 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
 114 Callback Functions</h2></td></tr>
 115 <tr class="memitem:gab0f1bc424462b8bbe0b2155d504025a5"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___s_c_r_i_p_t_i_n_g_gab0f1bc424462b8bbe0b2155d504025a5.html#gab0f1bc424462b8bbe0b2155d504025a5">Ucs_Ns_ResultCb_t</a> )(<a class="el" href="struct_ucs___rm___node__t.html">Ucs_Rm_Node_t</a> *node_ptr, <a class="el" href="group___g___u_c_s___s_c_r_i_p_t_i_n_g_gabd3ecc8ab539f3b9de3fc8045c083b60.html#gabd3ecc8ab539f3b9de3fc8045c083b60">Ucs_Ns_ResultCode_t</a> result, void *ucs_user_ptr)</td></tr>
 116 <tr class="memdesc:gab0f1bc424462b8bbe0b2155d504025a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function signature used for the results of the Scripting Manager.  <a href="#gab0f1bc424462b8bbe0b2155d504025a5"></a><br/></td></tr>
 117 <tr class="separator:gab0f1bc424462b8bbe0b2155d504025a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 118 </table><table class="memberdecls">
 119 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
 120 Enumerations</h2></td></tr>
 121 <tr class="memitem:gabd3ecc8ab539f3b9de3fc8045c083b60"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___s_c_r_i_p_t_i_n_g_gabd3ecc8ab539f3b9de3fc8045c083b60.html#gabd3ecc8ab539f3b9de3fc8045c083b60">Ucs_Ns_ResultCode_t</a> { <br/>
 122 &#160;&#160;<a class="el" href="group___g___u_c_s___s_c_r_i_p_t_i_n_g_gabd3ecc8ab539f3b9de3fc8045c083b60.html#ggabd3ecc8ab539f3b9de3fc8045c083b60af22bd910a1d7e2271b5b3cddf5892962">UCS_NS_RES_SUCCESS</a> = 0x00U,
 123 <br/>
 124 &#160;&#160;<a class="el" href="group___g___u_c_s___s_c_r_i_p_t_i_n_g_gabd3ecc8ab539f3b9de3fc8045c083b60.html#ggabd3ecc8ab539f3b9de3fc8045c083b60ad0ba0f8f6ba494e7685980d490e48b72">UCS_NS_RES_ERROR</a> = 0x01U
 125 <br/>
 126  }</td></tr>
 127 <tr class="memdesc:gabd3ecc8ab539f3b9de3fc8045c083b60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Result codes of the Node Script Management.  <a href="group___g___u_c_s___s_c_r_i_p_t_i_n_g_gabd3ecc8ab539f3b9de3fc8045c083b60.html#gabd3ecc8ab539f3b9de3fc8045c083b60">More...</a><br/></td></tr>
 128 <tr class="separator:gabd3ecc8ab539f3b9de3fc8045c083b60"><td class="memSeparator" colspan="2">&#160;</td></tr>
 129 </table><table class="memberdecls">
 130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 131 Functions</h2></td></tr>
 132 <tr class="memitem:ga2f2737e4d507b9c15e165918db3f1456"><td class="memItemLeft" align="right" valign="top"><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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___s_c_r_i_p_t_i_n_g_ga2f2737e4d507b9c15e165918db3f1456.html#ga2f2737e4d507b9c15e165918db3f1456">Ucs_Ns_Run</a> (<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> *self, <a class="el" href="struct_ucs___rm___node__t.html">Ucs_Rm_Node_t</a> *node_ptr, <a class="el" href="group___g___u_c_s___s_c_r_i_p_t_i_n_g_gab0f1bc424462b8bbe0b2155d504025a5.html#gab0f1bc424462b8bbe0b2155d504025a5">Ucs_Ns_ResultCb_t</a> result_fptr)</td></tr>
 133 <tr class="memdesc:ga2f2737e4d507b9c15e165918db3f1456"><td class="mdescLeft">&#160;</td><td class="mdescRight">Runs the script(s) contained in the given node.  <a href="#ga2f2737e4d507b9c15e165918db3f1456"></a><br/></td></tr>
 134 <tr class="separator:ga2f2737e4d507b9c15e165918db3f1456"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 </table>
 136 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 137 <p>Provides service function to allow execution of custom scripts in remote Nodes. </p>
 138 </div><!-- contents -->
 139 </div><!-- doc-content -->
 140 <!-- start footer part -->
 141 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 142   <ul>
 143     <li class="footer">&copy; 2017 Microchip Technology Inc. All rights reserved. <a href="http://www.microchip.com" target="_blank">www.microchip.com</a></li>
 144   </ul>
 145 </div>
 146 </body>
 147 <!--
 148 Generated on Mon Apr 3 2017 13:53:00 for UNICENS by
 149 Doxygen 1.8.2
 150 -->
 151 <script language="javascript">
 152 <!--
 153 $('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>');
 154 -->
 155 </script>
 156 </html>