ucs2-lib/doc/html/group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s.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: Referred Types</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___p_r_o_g___m_o_d_e___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="header">
  91   <div class="summary">
  92 <a href="#nested-classes">Data Structures</a> &#124;
  93 <a href="#enum-members">Enumerations</a>  </div>
  94   <div class="headertitle">
  95 <div class="title">Referred Types</div>  </div>
  96 <div class="ingroups"><a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e.html">Programming</a></div></div><!--header-->
  97 <div class="contents">
  98
  99 <p>Referred Types used by Programming Service.
 100 <a href="#details">More...</a></p>
 101 <table class="memberdecls">
 102 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
 103 Data Structures</h2></td></tr>
 104 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_ucs___prg___command__t.html">Ucs_Prg_Command_t</a></td></tr>
 105 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a programming task.  <a href="struct_ucs___prg___command__t.html#details">More...</a><br/></td></tr>
 106 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 107 </table><table class="memberdecls">
 108 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
 109 Enumerations</h2></td></tr>
 110 <tr class="memitem:gab29d4eadce18cb68209671a44c1eaa3a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gab29d4eadce18cb68209671a44c1eaa3a.html#gab29d4eadce18cb68209671a44c1eaa3a">Ucs_Prg_SessionType_t</a> { <br/>
 111 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gab29d4eadce18cb68209671a44c1eaa3a.html#ggab29d4eadce18cb68209671a44c1eaa3aa755ae5dbb2894e672423f34fcf94d4fe">UCS_PRG_ST_CS</a> = 0x01U,
 112 <br/>
 113 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gab29d4eadce18cb68209671a44c1eaa3a.html#ggab29d4eadce18cb68209671a44c1eaa3aa1301855aa66797f8170b86d61a0240dd">UCS_PRG_ST_IS</a> = 0x02U,
 114 <br/>
 115 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gab29d4eadce18cb68209671a44c1eaa3a.html#ggab29d4eadce18cb68209671a44c1eaa3aa344e76565c336dc329af00a8757242db">UCS_PRG_ST_CS_IS</a> = 0x04U,
 116 <br/>
 117 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gab29d4eadce18cb68209671a44c1eaa3a.html#ggab29d4eadce18cb68209671a44c1eaa3aa520aca46c3115f7cef0d37e084f68cd2">UCS_PRG_ST_ERASE_EM</a> = 0x08U,
 118 <br/>
 119 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gab29d4eadce18cb68209671a44c1eaa3a.html#ggab29d4eadce18cb68209671a44c1eaa3aae957e9ff8674900c12d4ced7f317bf83">UCS_PRG_ST_CFG_READ</a> = 0x10U
 120 <br/>
 121  }</td></tr>
 122 <tr class="memdesc:gab29d4eadce18cb68209671a44c1eaa3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines the set of MemIDs and the memory access types.  <a href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gab29d4eadce18cb68209671a44c1eaa3a.html#gab29d4eadce18cb68209671a44c1eaa3a">More...</a><br/></td></tr>
 123 <tr class="separator:gab29d4eadce18cb68209671a44c1eaa3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 124 <tr class="memitem:gae01f703f9ca91d9d1b9efdcfddfe8464"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gae01f703f9ca91d9d1b9efdcfddfe8464.html#gae01f703f9ca91d9d1b9efdcfddfe8464">Ucs_Prg_MemId_t</a> { <br/>
 125 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gae01f703f9ca91d9d1b9efdcfddfe8464.html#ggae01f703f9ca91d9d1b9efdcfddfe8464a7b9d362953b3eb6650b502e0a2de1d87">UCS_PRG_MID_CS</a> = 0x00U,
 126 <br/>
 127 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gae01f703f9ca91d9d1b9efdcfddfe8464.html#ggae01f703f9ca91d9d1b9efdcfddfe8464a7aec4bc748bba83bc72b20589dbb8187">UCS_PRG_MID_IS</a> = 0x01U,
 128 <br/>
 129 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gae01f703f9ca91d9d1b9efdcfddfe8464.html#ggae01f703f9ca91d9d1b9efdcfddfe8464aee7f85fb6df6f70f6f09757f41a1ff3e">UCS_PRG_MID_CSTEST</a> = 0x0CU,
 130 <br/>
 131 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gae01f703f9ca91d9d1b9efdcfddfe8464.html#ggae01f703f9ca91d9d1b9efdcfddfe8464a6aebc0c00f88f30ddfcea30b9a1d79bd">UCS_PRG_MID_ISTEST</a> = 0x0DU
 132 <br/>
 133  }</td></tr>
 134 <tr class="memdesc:gae01f703f9ca91d9d1b9efdcfddfe8464"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents the memory resource to be written.  <a href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gae01f703f9ca91d9d1b9efdcfddfe8464.html#gae01f703f9ca91d9d1b9efdcfddfe8464">More...</a><br/></td></tr>
 135 <tr class="separator:gae01f703f9ca91d9d1b9efdcfddfe8464"><td class="memSeparator" colspan="2">&#160;</td></tr>
 136 <tr class="memitem:gaa998005dc2e710169a39af0c3739ade2"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gaa998005dc2e710169a39af0c3739ade2.html#gaa998005dc2e710169a39af0c3739ade2">Ucs_Prg_ResCode_t</a> { <br/>
 137 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gaa998005dc2e710169a39af0c3739ade2.html#ggaa998005dc2e710169a39af0c3739ade2a9fa199d254d8b56a36b83bdefc5e213e">UCS_PRG_RES_SUCCESS</a> = 0x01U,
 138 <br/>
 139 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gaa998005dc2e710169a39af0c3739ade2.html#ggaa998005dc2e710169a39af0c3739ade2a4895d31da9d98951666b8bebf31dd316">UCS_PRG_RES_TIMEOUT</a> = 0x02U,
 140 <br/>
 141 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gaa998005dc2e710169a39af0c3739ade2.html#ggaa998005dc2e710169a39af0c3739ade2a960ff74b4fab89700a44087c8f51a546">UCS_PRG_RES_NET_OFF</a> = 0x03U,
 142 <br/>
 143 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gaa998005dc2e710169a39af0c3739ade2.html#ggaa998005dc2e710169a39af0c3739ade2a47fc805dfdab644983d36b195e6de5e9">UCS_PRG_RES_FKT_SYNCH</a> = 0x04U,
 144 <br/>
 145 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gaa998005dc2e710169a39af0c3739ade2.html#ggaa998005dc2e710169a39af0c3739ade2ae99cf57eece62df6910adeafbb900a49">UCS_PRG_RES_FKT_ASYNCH</a> = 0x05U,
 146 <br/>
 147 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gaa998005dc2e710169a39af0c3739ade2.html#ggaa998005dc2e710169a39af0c3739ade2afd20cb6be3412f26421e5878d4123fc0">UCS_PRG_RES_ERROR</a> = 0x06U
 148 <br/>
 149  }</td></tr>
 150 <tr class="memdesc:gaa998005dc2e710169a39af0c3739ade2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Result values of the Programming service.  <a href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gaa998005dc2e710169a39af0c3739ade2.html#gaa998005dc2e710169a39af0c3739ade2">More...</a><br/></td></tr>
 151 <tr class="separator:gaa998005dc2e710169a39af0c3739ade2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:ga25cd4c3a9113e0a25b65136fec561c83"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_ga25cd4c3a9113e0a25b65136fec561c83.html#ga25cd4c3a9113e0a25b65136fec561c83">Ucs_Prg_Func_t</a> { <br/>
 153 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_ga25cd4c3a9113e0a25b65136fec561c83.html#gga25cd4c3a9113e0a25b65136fec561c83a571bfec1b0e2f178223e6ad468ecfb92">UCS_PRG_FKT_DUMMY</a> = 0x00U,
 154 <br/>
 155 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_ga25cd4c3a9113e0a25b65136fec561c83.html#gga25cd4c3a9113e0a25b65136fec561c83a6bc3776ea617b865cde396fac4df9a5a">UCS_PRG_FKT_WELCOME</a> = 0x01U,
 156 <br/>
 157 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_ga25cd4c3a9113e0a25b65136fec561c83.html#gga25cd4c3a9113e0a25b65136fec561c83a308862104fb675865f9ae6d9670ec40b">UCS_PRG_FKT_WELCOME_NOSUCCESS</a> = 0x02U,
 158 <br/>
 159 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_ga25cd4c3a9113e0a25b65136fec561c83.html#gga25cd4c3a9113e0a25b65136fec561c83a062c6eb1a133b3b61dd24244121fda4b">UCS_PRG_FKT_MEM_OPEN</a> = 0x03U,
 160 <br/>
 161 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_ga25cd4c3a9113e0a25b65136fec561c83.html#gga25cd4c3a9113e0a25b65136fec561c83a359370a24ff37bdde070efc8c887599f">UCS_PRG_FKT_MEM_WRITE</a> = 0x04U,
 162 <br/>
 163 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_ga25cd4c3a9113e0a25b65136fec561c83.html#gga25cd4c3a9113e0a25b65136fec561c83a0071da47fdc967e0c6ce18cc464c3c1c">UCS_PRG_FKT_MEM_CLOSE</a> = 0x05U,
 164 <br/>
 165 &#160;&#160;<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_ga25cd4c3a9113e0a25b65136fec561c83.html#gga25cd4c3a9113e0a25b65136fec561c83a1cefbe47e784b8a872bec98922a7d1f6">UCS_PRG_FKT_INIT</a> = 0x06U
 166 <br/>
 167  }</td></tr>
 168 <tr class="memdesc:ga25cd4c3a9113e0a25b65136fec561c83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Denotes the function where an error occurred.  <a href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_ga25cd4c3a9113e0a25b65136fec561c83.html#ga25cd4c3a9113e0a25b65136fec561c83">More...</a><br/></td></tr>
 169 <tr class="separator:ga25cd4c3a9113e0a25b65136fec561c83"><td class="memSeparator" colspan="2">&#160;</td></tr>
 170 </table>
 171 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 172 <p>Referred Types used by Programming Service. </p>
 173 </div><!-- contents -->
 174 </div><!-- doc-content -->
 175 <!-- start footer part -->
 176 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 177   <ul>
 178     <li class="footer">&copy; 2017 Microchip Technology Inc. All rights reserved. <a href="http://www.microchip.com" target="_blank">www.microchip.com</a></li>
 179   </ul>
 180 </div>
 181 </body>
 182 <!--
 183 Generated on Mon Apr 3 2017 13:53:00 for UNICENS by
 184 Doxygen 1.8.2
 185 -->
 186 <script language="javascript">
 187 <!--
 188 $('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>');
 189 -->
 190 </script>
 191 </html>