begriffs open source - cmsis/blob - dev/v6.0.0-dev53/RTOS2/html/group__flags__error__codes.html

   1 <!-- HTML header for doxygen 1.9.6-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>CMSIS-RTOS2: Flags Functions Error Codes</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="jquery.js"></script>
  15 <script type="text/javascript" src="dynsections.js"></script>
  16 <script type="text/javascript" src="printComponentTabs.js"></script>
  17 <script type="text/javascript" src="footer.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="resize.js"></script>
  21 <script type="text/javascript" src="navtreedata.js"></script>
  22 <script type="text/javascript" src="navtree.js"></script>
  23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  24 <script type="text/javascript" src="search/searchdata.js"></script>
  25 <script type="text/javascript" src="search/search.js"></script>
  26 <script type="text/javascript">
  27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  28   $(document).ready(function() { init_search(); });
  29 /* @license-end */
  30 </script>
  31 <script type="text/javascript" src="darkmode_toggle.js"></script>
  32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  35 <link href="version.css" rel="stylesheet" type="text/css" />
  36 <script type="text/javascript" src="../../../version.js"></script>
  37 </head>
  38 <body>
  39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40 <div id="titlearea">
  41 <table cellspacing="0" cellpadding="0">
  42  <tbody>
  43  <tr style="height: 55px;">
  44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  46    <div id="projectname">CMSIS-RTOS2
  47    &#160;<span id="projectnumber"><script type="text/javascript">
  48      <!--
  49      writeHeader.call(this);
  50      writeVersionDropdown.call(this);
  51      //-->
  52     </script>
  53    </span>
  54    </div>
  55    <div id="projectbrief">Real-Time Operating System API</div>
  56   </td>
  57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  58         <span class="left">
  59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  66           </span>
  67         </div>
  68 </td>
  69   <!--END !PROJECT_NAME-->
  70  </tr>
  71  </tbody>
  72 </table>
  73 </div>
  74 <!-- end header part -->
  75 <div id="CMSISnav" class="tabs1">
  76   <ul class="tablist">
  77     <script type="text/javascript">
  78       writeComponentTabs.call(this);
  79     </script>
  80   </ul>
  81 </div>
  82 <script type="text/javascript">
  83   writeSubComponentTabs.call(this);
  84 </script>
  85 <!-- Generated by Doxygen 1.9.6 -->
  86 <script type="text/javascript">
  87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  88 var searchBox = new SearchBox("searchBox", "search/",'.html');
  89 /* @license-end */
  90 </script>
  91 </div><!-- top -->
  92 <div id="side-nav" class="ui-resizable side-nav-resizable">
  93   <div id="nav-tree">
  94     <div id="nav-tree-contents">
  95       <div id="nav-sync" class="sync"></div>
  96     </div>
  97   </div>
  98   <div id="splitbar" style="-moz-user-select:none;"
  99        class="ui-resizable-handle">
 100   </div>
 101 </div>
 102 <script type="text/javascript">
 103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 104 $(document).ready(function(){initNavTree('group__flags__error__codes.html',''); initResizable(); });
 105 /* @license-end */
 106 </script>
 107 <div id="doc-content">
 108 <!-- window showing the filter options -->
 109 <div id="MSearchSelectWindow"
 110      onmouseover="return searchBox.OnSearchSelectShow()"
 111      onmouseout="return searchBox.OnSearchSelectHide()"
 112      onkeydown="return searchBox.OnSearchSelectKey(event)">
 113 </div>
 114
 115 <!-- iframe showing the search results (closed by default) -->
 116 <div id="MSearchResultsWindow">
 117 <div id="MSearchResults">
 118 <div class="SRPage">
 119 <div id="SRIndex">
 120 <div id="SRResults"></div>
 121 <div class="SRStatus" id="Loading">Loading...</div>
 122 <div class="SRStatus" id="Searching">Searching...</div>
 123 <div class="SRStatus" id="NoMatches">No Matches</div>
 124 </div>
 125 </div>
 126 </div>
 127 </div>
 128
 129 <div class="header">
 130   <div class="summary">
 131 <a href="#define-members">Macros</a>  </div>
 132   <div class="headertitle"><div class="title">Flags Functions Error Codes<div class="ingroups"><a class="el" href="group__CMSIS__RTOS.html">CMSIS-RTOS2 API</a> &raquo; <a class="el" href="group__CMSIS__RTOS__Definitions.html">Generic Definitions</a></div></div></div>
 133 </div><!--header-->
 134 <div class="contents">
 135
 136 <p>Constants used by <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html">Thread Flags</a> and <a class="el" href="group__CMSIS__RTOS__EventFlags.html">Event Flags</a> to return error codes.
 137 <a href="#details">More...</a></p>
 138 <table class="memberdecls">
 139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 140 Macros</h2></td></tr>
 141 <tr class="memitem:ga3b1d9fbb83d64eedb62f831c9be647c3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flags__error__codes.html#ga3b1d9fbb83d64eedb62f831c9be647c3">osFlagsErrorUnknown</a>&#160;&#160;&#160;0xFFFFFFFFU</td></tr>
 142 <tr class="memdesc:ga3b1d9fbb83d64eedb62f831c9be647c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">osError (-1).  <br /></td></tr>
 143 <tr class="separator:ga3b1d9fbb83d64eedb62f831c9be647c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:ga2e951c3f1c3b7bff4eca3d7836cd19ca"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flags__error__codes.html#ga2e951c3f1c3b7bff4eca3d7836cd19ca">osFlagsErrorTimeout</a>&#160;&#160;&#160;0xFFFFFFFEU</td></tr>
 145 <tr class="memdesc:ga2e951c3f1c3b7bff4eca3d7836cd19ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">osErrorTimeout (-2).  <br /></td></tr>
 146 <tr class="separator:ga2e951c3f1c3b7bff4eca3d7836cd19ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:ga4db38b50da1889bcaaa7f747e844f904"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flags__error__codes.html#ga4db38b50da1889bcaaa7f747e844f904">osFlagsErrorResource</a>&#160;&#160;&#160;0xFFFFFFFDU</td></tr>
 148 <tr class="memdesc:ga4db38b50da1889bcaaa7f747e844f904"><td class="mdescLeft">&#160;</td><td class="mdescRight">osErrorResource (-3).  <br /></td></tr>
 149 <tr class="separator:ga4db38b50da1889bcaaa7f747e844f904"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:gaa8a95ef938f8f5a9fcb815ec53184f77"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flags__error__codes.html#gaa8a95ef938f8f5a9fcb815ec53184f77">osFlagsErrorParameter</a>&#160;&#160;&#160;0xFFFFFFFCU</td></tr>
 151 <tr class="memdesc:gaa8a95ef938f8f5a9fcb815ec53184f77"><td class="mdescLeft">&#160;</td><td class="mdescRight">osErrorParameter (-4).  <br /></td></tr>
 152 <tr class="separator:gaa8a95ef938f8f5a9fcb815ec53184f77"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:gaea3abd186643f539877e894b62b63448"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flags__error__codes.html#gaea3abd186643f539877e894b62b63448">osFlagsErrorISR</a>&#160;&#160;&#160;0xFFFFFFFAU</td></tr>
 154 <tr class="memdesc:gaea3abd186643f539877e894b62b63448"><td class="mdescLeft">&#160;</td><td class="mdescRight">osErrorISR (-6).  <br /></td></tr>
 155 <tr class="separator:gaea3abd186643f539877e894b62b63448"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 </table>
 157 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 158 <p>Constants used by <a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html">Thread Flags</a> and <a class="el" href="group__CMSIS__RTOS__EventFlags.html">Event Flags</a> to return error codes. </p>
 159 <p>In case of an error, flags functions (<a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html">Thread Flags</a> and <a class="el" href="group__CMSIS__RTOS__EventFlags.html">Event Flags</a>) return error codes. To indicate that an error has occurred, the highest bit of the return value is be set. You can check the exact error using the codes shown below. </p>
 160 <h2 class="groupheader">Macro Definition Documentation</h2>
 161 <a id="ga3b1d9fbb83d64eedb62f831c9be647c3" name="ga3b1d9fbb83d64eedb62f831c9be647c3"></a>
 162 <h2 class="memtitle"><span class="permalink"><a href="#ga3b1d9fbb83d64eedb62f831c9be647c3">&#9670;&#160;</a></span>osFlagsErrorUnknown</h2>
 163
 164 <div class="memitem">
 165 <div class="memproto">
 166       <table class="memname">
 167         <tr>
 168           <td class="memname">#define osFlagsErrorUnknown&#160;&#160;&#160;0xFFFFFFFFU</td>
 169         </tr>
 170       </table>
 171 </div><div class="memdoc">
 172
 173 <p>osError (-1). </p>
 174 <p>Generic error. It is returned when no other error can be applied.</p>
 175 <p>Reference:</p><ul>
 176 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a></li>
 177 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga656abc1c862c5b9a2b13584c42cc0bfa">osThreadFlagsClear</a></li>
 178 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a></li>
 179 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e">osEventFlagsSet</a></li>
 180 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga93bf258ca0007c6641fbe8e4f2b8a1e5">osEventFlagsClear</a></li>
 181 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a> </li>
 182 </ul>
 183
 184 </div>
 185 </div>
 186 <a id="ga2e951c3f1c3b7bff4eca3d7836cd19ca" name="ga2e951c3f1c3b7bff4eca3d7836cd19ca"></a>
 187 <h2 class="memtitle"><span class="permalink"><a href="#ga2e951c3f1c3b7bff4eca3d7836cd19ca">&#9670;&#160;</a></span>osFlagsErrorTimeout</h2>
 188
 189 <div class="memitem">
 190 <div class="memproto">
 191       <table class="memname">
 192         <tr>
 193           <td class="memname">#define osFlagsErrorTimeout&#160;&#160;&#160;0xFFFFFFFEU</td>
 194         </tr>
 195       </table>
 196 </div><div class="memdoc">
 197
 198 <p>osErrorTimeout (-2). </p>
 199 <p>This error is returned if a timeout was specified and the specified flags were not set, when the timeout occurred.</p>
 200 <p>Reference:</p><ul>
 201 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a></li>
 202 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga656abc1c862c5b9a2b13584c42cc0bfa">osThreadFlagsClear</a></li>
 203 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a></li>
 204 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e">osEventFlagsSet</a></li>
 205 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga93bf258ca0007c6641fbe8e4f2b8a1e5">osEventFlagsClear</a></li>
 206 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a> </li>
 207 </ul>
 208
 209 </div>
 210 </div>
 211 <a id="ga4db38b50da1889bcaaa7f747e844f904" name="ga4db38b50da1889bcaaa7f747e844f904"></a>
 212 <h2 class="memtitle"><span class="permalink"><a href="#ga4db38b50da1889bcaaa7f747e844f904">&#9670;&#160;</a></span>osFlagsErrorResource</h2>
 213
 214 <div class="memitem">
 215 <div class="memproto">
 216       <table class="memname">
 217         <tr>
 218           <td class="memname">#define osFlagsErrorResource&#160;&#160;&#160;0xFFFFFFFDU</td>
 219         </tr>
 220       </table>
 221 </div><div class="memdoc">
 222
 223 <p>osErrorResource (-3). </p>
 224 <p>This error is returned when you try to get a flag that was not set <em>and</em> timeout 0 was specified. Is also returned when the specified object identifier is corrupt or invalid.</p>
 225 <p>Reference:</p><ul>
 226 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a></li>
 227 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga656abc1c862c5b9a2b13584c42cc0bfa">osThreadFlagsClear</a></li>
 228 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a></li>
 229 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e">osEventFlagsSet</a></li>
 230 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga93bf258ca0007c6641fbe8e4f2b8a1e5">osEventFlagsClear</a></li>
 231 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a> </li>
 232 </ul>
 233
 234 </div>
 235 </div>
 236 <a id="gaa8a95ef938f8f5a9fcb815ec53184f77" name="gaa8a95ef938f8f5a9fcb815ec53184f77"></a>
 237 <h2 class="memtitle"><span class="permalink"><a href="#gaa8a95ef938f8f5a9fcb815ec53184f77">&#9670;&#160;</a></span>osFlagsErrorParameter</h2>
 238
 239 <div class="memitem">
 240 <div class="memproto">
 241       <table class="memname">
 242         <tr>
 243           <td class="memname">#define osFlagsErrorParameter&#160;&#160;&#160;0xFFFFFFFCU</td>
 244         </tr>
 245       </table>
 246 </div><div class="memdoc">
 247
 248 <p>osErrorParameter (-4). </p>
 249 <p>This error is returned when a given parameter is wrong.</p>
 250 <p>Reference:</p><ul>
 251 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a></li>
 252 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga656abc1c862c5b9a2b13584c42cc0bfa">osThreadFlagsClear</a></li>
 253 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a></li>
 254 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e">osEventFlagsSet</a></li>
 255 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga93bf258ca0007c6641fbe8e4f2b8a1e5">osEventFlagsClear</a></li>
 256 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a> </li>
 257 </ul>
 258
 259 </div>
 260 </div>
 261 <a id="gaea3abd186643f539877e894b62b63448" name="gaea3abd186643f539877e894b62b63448"></a>
 262 <h2 class="memtitle"><span class="permalink"><a href="#gaea3abd186643f539877e894b62b63448">&#9670;&#160;</a></span>osFlagsErrorISR</h2>
 263
 264 <div class="memitem">
 265 <div class="memproto">
 266       <table class="memname">
 267         <tr>
 268           <td class="memname">#define osFlagsErrorISR&#160;&#160;&#160;0xFFFFFFFAU</td>
 269         </tr>
 270       </table>
 271 </div><div class="memdoc">
 272
 273 <p>osErrorISR (-6). </p>
 274 <p>This error is returned when a non-ISR-callable function was called from an ISR.</p>
 275 <p>Reference:</p><ul>
 276 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a></li>
 277 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga656abc1c862c5b9a2b13584c42cc0bfa">osThreadFlagsClear</a></li>
 278 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a></li>
 279 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e">osEventFlagsSet</a></li>
 280 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga93bf258ca0007c6641fbe8e4f2b8a1e5">osEventFlagsClear</a></li>
 281 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a> </li>
 282 </ul>
 283
 284 </div>
 285 </div>
 286 </div><!-- contents -->
 287 </div><!-- doc-content -->
 288 <!-- start footer part -->
 289 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 290   <ul>
 291     <li class="footer">
 292       <script type="text/javascript">
 293         <!--
 294         writeFooter.call(this);
 295         //-->
 296       </script>
 297     </li>
 298   </ul>
 299 </div>
 300 </body>
 301 </html>