begriffs open source - cmsis/blob - main/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, "CMSIS-RTOS2");
  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 <!-- Generated by Doxygen 1.9.6 -->
  83 <script type="text/javascript">
  84 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  85 var searchBox = new SearchBox("searchBox", "search/",'.html');
  86 /* @license-end */
  87 </script>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 101 $(document).ready(function(){initNavTree('group__flags__error__codes.html',''); initResizable(); });
 102 /* @license-end */
 103 </script>
 104 <div id="doc-content">
 105 <!-- window showing the filter options -->
 106 <div id="MSearchSelectWindow"
 107      onmouseover="return searchBox.OnSearchSelectShow()"
 108      onmouseout="return searchBox.OnSearchSelectHide()"
 109      onkeydown="return searchBox.OnSearchSelectKey(event)">
 110 </div>
 111
 112 <!-- iframe showing the search results (closed by default) -->
 113 <div id="MSearchResultsWindow">
 114 <div id="MSearchResults">
 115 <div class="SRPage">
 116 <div id="SRIndex">
 117 <div id="SRResults"></div>
 118 <div class="SRStatus" id="Loading">Loading...</div>
 119 <div class="SRStatus" id="Searching">Searching...</div>
 120 <div class="SRStatus" id="NoMatches">No Matches</div>
 121 </div>
 122 </div>
 123 </div>
 124 </div>
 125
 126 <div class="header">
 127   <div class="summary">
 128 <a href="#define-members">Macros</a>  </div>
 129   <div class="headertitle"><div class="title">Flags Functions Error Codes<div class="ingroups"><a class="el" href="group__CMSIS__RTOS.html">CMSIS-RTOS API v2</a> &raquo; <a class="el" href="group__CMSIS__RTOS__Definitions.html">Definitions</a></div></div></div>
 130 </div><!--header-->
 131 <div class="contents">
 132
 133 <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.
 134 <a href="#details">More...</a></p>
 135 <table class="memberdecls">
 136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 137 Macros</h2></td></tr>
 138 <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>
 139 <tr class="memdesc:ga3b1d9fbb83d64eedb62f831c9be647c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">osError (-1).  <br /></td></tr>
 140 <tr class="separator:ga3b1d9fbb83d64eedb62f831c9be647c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <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>
 142 <tr class="memdesc:ga2e951c3f1c3b7bff4eca3d7836cd19ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">osErrorTimeout (-2).  <br /></td></tr>
 143 <tr class="separator:ga2e951c3f1c3b7bff4eca3d7836cd19ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <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>
 145 <tr class="memdesc:ga4db38b50da1889bcaaa7f747e844f904"><td class="mdescLeft">&#160;</td><td class="mdescRight">osErrorResource (-3).  <br /></td></tr>
 146 <tr class="separator:ga4db38b50da1889bcaaa7f747e844f904"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <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>
 148 <tr class="memdesc:gaa8a95ef938f8f5a9fcb815ec53184f77"><td class="mdescLeft">&#160;</td><td class="mdescRight">osErrorParameter (-4).  <br /></td></tr>
 149 <tr class="separator:gaa8a95ef938f8f5a9fcb815ec53184f77"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <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>
 151 <tr class="memdesc:gaea3abd186643f539877e894b62b63448"><td class="mdescLeft">&#160;</td><td class="mdescRight">osErrorISR (-6).  <br /></td></tr>
 152 <tr class="separator:gaea3abd186643f539877e894b62b63448"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 </table>
 154 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 155 <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>
 156 <h2 class="groupheader">Macro Definition Documentation</h2>
 157 <a id="ga3b1d9fbb83d64eedb62f831c9be647c3" name="ga3b1d9fbb83d64eedb62f831c9be647c3"></a>
 158 <h2 class="memtitle"><span class="permalink"><a href="#ga3b1d9fbb83d64eedb62f831c9be647c3">&#9670;&#160;</a></span>osFlagsErrorUnknown</h2>
 159
 160 <div class="memitem">
 161 <div class="memproto">
 162       <table class="memname">
 163         <tr>
 164           <td class="memname">#define osFlagsErrorUnknown&#160;&#160;&#160;0xFFFFFFFFU</td>
 165         </tr>
 166       </table>
 167 </div><div class="memdoc">
 168 <p>Generic error. It is returned when no other error can be applied.</p>
 169 <p>Reference:</p><ul>
 170 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a></li>
 171 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga656abc1c862c5b9a2b13584c42cc0bfa">osThreadFlagsClear</a></li>
 172 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a></li>
 173 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e">osEventFlagsSet</a></li>
 174 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga93bf258ca0007c6641fbe8e4f2b8a1e5">osEventFlagsClear</a></li>
 175 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a> </li>
 176 </ul>
 177
 178 </div>
 179 </div>
 180 <a id="ga2e951c3f1c3b7bff4eca3d7836cd19ca" name="ga2e951c3f1c3b7bff4eca3d7836cd19ca"></a>
 181 <h2 class="memtitle"><span class="permalink"><a href="#ga2e951c3f1c3b7bff4eca3d7836cd19ca">&#9670;&#160;</a></span>osFlagsErrorTimeout</h2>
 182
 183 <div class="memitem">
 184 <div class="memproto">
 185       <table class="memname">
 186         <tr>
 187           <td class="memname">#define osFlagsErrorTimeout&#160;&#160;&#160;0xFFFFFFFEU</td>
 188         </tr>
 189       </table>
 190 </div><div class="memdoc">
 191 <p>This error is returned if a timeout was specified and the specified flags were not set, when the timeout occurred.</p>
 192 <p>Reference:</p><ul>
 193 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a></li>
 194 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga656abc1c862c5b9a2b13584c42cc0bfa">osThreadFlagsClear</a></li>
 195 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a></li>
 196 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e">osEventFlagsSet</a></li>
 197 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga93bf258ca0007c6641fbe8e4f2b8a1e5">osEventFlagsClear</a></li>
 198 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a> </li>
 199 </ul>
 200
 201 </div>
 202 </div>
 203 <a id="ga4db38b50da1889bcaaa7f747e844f904" name="ga4db38b50da1889bcaaa7f747e844f904"></a>
 204 <h2 class="memtitle"><span class="permalink"><a href="#ga4db38b50da1889bcaaa7f747e844f904">&#9670;&#160;</a></span>osFlagsErrorResource</h2>
 205
 206 <div class="memitem">
 207 <div class="memproto">
 208       <table class="memname">
 209         <tr>
 210           <td class="memname">#define osFlagsErrorResource&#160;&#160;&#160;0xFFFFFFFDU</td>
 211         </tr>
 212       </table>
 213 </div><div class="memdoc">
 214 <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>
 215 <p>Reference:</p><ul>
 216 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a></li>
 217 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga656abc1c862c5b9a2b13584c42cc0bfa">osThreadFlagsClear</a></li>
 218 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a></li>
 219 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e">osEventFlagsSet</a></li>
 220 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga93bf258ca0007c6641fbe8e4f2b8a1e5">osEventFlagsClear</a></li>
 221 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a> </li>
 222 </ul>
 223
 224 </div>
 225 </div>
 226 <a id="gaa8a95ef938f8f5a9fcb815ec53184f77" name="gaa8a95ef938f8f5a9fcb815ec53184f77"></a>
 227 <h2 class="memtitle"><span class="permalink"><a href="#gaa8a95ef938f8f5a9fcb815ec53184f77">&#9670;&#160;</a></span>osFlagsErrorParameter</h2>
 228
 229 <div class="memitem">
 230 <div class="memproto">
 231       <table class="memname">
 232         <tr>
 233           <td class="memname">#define osFlagsErrorParameter&#160;&#160;&#160;0xFFFFFFFCU</td>
 234         </tr>
 235       </table>
 236 </div><div class="memdoc">
 237 <p>This error is returned when a given parameter is wrong.</p>
 238 <p>Reference:</p><ul>
 239 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a></li>
 240 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga656abc1c862c5b9a2b13584c42cc0bfa">osThreadFlagsClear</a></li>
 241 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a></li>
 242 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e">osEventFlagsSet</a></li>
 243 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga93bf258ca0007c6641fbe8e4f2b8a1e5">osEventFlagsClear</a></li>
 244 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a> </li>
 245 </ul>
 246
 247 </div>
 248 </div>
 249 <a id="gaea3abd186643f539877e894b62b63448" name="gaea3abd186643f539877e894b62b63448"></a>
 250 <h2 class="memtitle"><span class="permalink"><a href="#gaea3abd186643f539877e894b62b63448">&#9670;&#160;</a></span>osFlagsErrorISR</h2>
 251
 252 <div class="memitem">
 253 <div class="memproto">
 254       <table class="memname">
 255         <tr>
 256           <td class="memname">#define osFlagsErrorISR&#160;&#160;&#160;0xFFFFFFFAU</td>
 257         </tr>
 258       </table>
 259 </div><div class="memdoc">
 260 <p>This error is returned when a non-ISR-callable function was called from an ISR.</p>
 261 <p>Reference:</p><ul>
 262 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga6f89ef9caded1d9963c7b12b0f6412c9">osThreadFlagsSet</a></li>
 263 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#ga656abc1c862c5b9a2b13584c42cc0bfa">osThreadFlagsClear</a></li>
 264 <li><a class="el" href="group__CMSIS__RTOS__ThreadFlagsMgmt.html#gac11542ad6300b600f872fc96e340ec2b">osThreadFlagsWait</a></li>
 265 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga33b71d14cecf90b4e72639dd19f23a5e">osEventFlagsSet</a></li>
 266 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga93bf258ca0007c6641fbe8e4f2b8a1e5">osEventFlagsClear</a></li>
 267 <li><a class="el" href="group__CMSIS__RTOS__EventFlags.html#ga52acb34a8322e58020227344fe662b4e">osEventFlagsWait</a> </li>
 268 </ul>
 269
 270 </div>
 271 </div>
 272 </div><!-- contents -->
 273 </div><!-- doc-content -->
 274 <!-- start footer part -->
 275 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 276   <ul>
 277     <li class="footer">
 278       <script type="text/javascript">
 279         <!--
 280         writeFooter.call(this);
 281         //-->
 282       </script>
 283     </li>
 284   </ul>
 285 </div>
 286 </body>
 287 </html>