2019-05-15 10:57:06 +01:00
<!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" / >
2019-10-18 15:30:02 +01:00
< title > Generic Data Types and Definitions< / title >
< title > CMSIS-RTOS: Generic Data Types and Definitions< / title >
2019-05-15 10:57:06 +01:00
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< link href = "cmsis.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< script type = "text/javascript" src = "printComponentTabs.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);
2019-10-18 15:30:02 +01:00
$(window).load(resizeHeight);
2019-05-15 10:57:06 +01:00
< / 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 >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 46px;" >
< td id = "projectlogo" > < img alt = "Logo" src = "CMSIS_Logo_Final.png" / > < / td >
< td style = "padding-left: 0.5em;" >
2019-10-18 15:30:02 +01:00
< div id = "projectname" > CMSIS-RTOS
  < span id = "projectnumber" > Version 1.03< / span >
2019-05-15 10:57:06 +01:00
< / div >
2019-10-18 15:30:02 +01:00
< div id = "projectbrief" > Real-Time Operating System: API and RTX Reference Implementation.< / div >
2019-05-15 10:57:06 +01:00
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
< div id = "CMSISnav" class = "tabs1" >
< ul class = "tablist" >
< script type = "text/javascript" >
<!--
writeComponentTabs.call(this);
//-->
< / script >
< / ul >
< / div >
2019-10-18 15:30:02 +01:00
<!-- Generated by Doxygen 1.8.6 -->
2019-05-15 10:57:06 +01:00
< script type = "text/javascript" >
var searchBox = new SearchBox("searchBox", "search",false,'Search');
< / script >
< div id = "navrow1" class = "tabs" >
< ul class = "tablist" >
< li > < a href = "index.html" > < span > Main  Page< / span > < / a > < / li >
< li > < a href = "pages.html" > < span > Usage  and  Description< / span > < / a > < / li >
< li > < a href = "modules.html" > < span > Reference< / span > < / a > < / li >
< li >
< 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 >
< / li >
< / ul >
< / div >
< / 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" >
2019-10-18 15:30:02 +01:00
$(document).ready(function(){initNavTree('group__CMSIS__RTOS__Definitions.html','');});
2019-05-15 10:57:06 +01:00
< / 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 > Files< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(3)" > < span class = "SelectionMark" >   < / span > Functions< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(4)" > < span class = "SelectionMark" >   < / span > Variables< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(5)" > < span class = "SelectionMark" >   < / span > Typedefs< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(6)" > < span class = "SelectionMark" >   < / span > Enumerations< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(7)" > < span class = "SelectionMark" >   < / span > Enumerator< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(8)" > < span class = "SelectionMark" >   < / span > Macros< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(9)" > < span class = "SelectionMark" >   < / span > Groups< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(10)" > < 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 = "header" >
< div class = "summary" >
2019-10-18 15:30:02 +01:00
< a href = "#nested-classes" > Data Structures< / a > < / div >
2019-05-15 10:57:06 +01:00
< div class = "headertitle" >
2019-10-18 15:30:02 +01:00
< div class = "title" > Generic Data Types and Definitions< div class = "ingroups" > < a class = "el" href = "group__CMSIS__RTOS.html" > CMSIS-RTOS API< / a > < / div > < / div > < / div >
2019-05-15 10:57:06 +01:00
< / div > <!-- header -->
< div class = "contents" >
2019-10-18 15:30:02 +01:00
< p > Data Type Definitions used by the CMSIS-RTOS API functions.
< a href = "#details" > More...< / a > < / p >
2019-05-15 10:57:06 +01:00
< table class = "memberdecls" >
2019-10-18 15:30:02 +01:00
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "nested-classes" > < / a >
Data Structures< / h2 > < / td > < / tr >
< tr class = "memitem:structosEvent" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__Definitions.html#structosEvent" > osEvent< / a > < / td > < / tr >
< tr class = "memdesc:structosEvent" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Event structure contains detailed information about an event. < a href = "group__CMSIS__RTOS__Definitions.html#structosEvent" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:structosEvent" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:unionosEvent_8value" > < td class = "memItemLeft" align = "right" valign = "top" > union   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__Definitions.html#unionosEvent_8value" > osEvent.value< / a > < / td > < / tr >
< tr class = "separator:unionosEvent_8value" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:unionosEvent_8def" > < td class = "memItemLeft" align = "right" valign = "top" > union   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__Definitions.html#unionosEvent_8def" > osEvent.def< / a > < / td > < / tr >
< tr class = "separator:unionosEvent_8def" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:structos__mailQ" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__CMSIS__RTOS__Definitions.html#structos__mailQ" > os_mailQ< / a > < / td > < / tr >
< tr class = "separator:structos__mailQ" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2019-05-15 10:57:06 +01:00
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Description< / h2 >
2019-10-18 15:30:02 +01:00
< p > The Data Type section lists all data types that are used to exchange information with CMSIS-RTOS functions. < / p >
< hr / > < h2 class = "groupheader" > Data Structure Documentation< / h2 >
< a name = "structosEvent" id = "structosEvent" > < / a >
2019-05-15 10:57:06 +01:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2019-10-18 15:30:02 +01:00
< td class = "memname" > struct osEvent< / td >
2019-05-15 10:57:06 +01:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2019-10-18 15:30:02 +01:00
< div class = "textblock" > < dl class = "section note" > < dt > Note< / dt > < dd > MUST REMAIN UNCHANGED: < b > os_event< / b > shall be consistent in every CMSIS-RTOS. However the struct may be extended at the end.< / dd > < / dl >
< p > The < b > < a class = "el" href = "group__CMSIS__RTOS__Definitions.html#structosEvent" title = "Event structure contains detailed information about an event. " > osEvent< / a > < / b > structure describes the events returned by CMSIS-RTOS functions. < / p >
< / div > < table class = "fieldtable" >
< tr > < th colspan = "3" > Data Fields< / th > < / tr >
< tr > < td class = "fieldtype" >
< a class = "anchor" id = "a596b6d55c3321db19239256bbe403df6" > < / a > union < a class = "el" href = "group__CMSIS__RTOS__Definitions.html#unionosEvent_8def" > osEvent< / a > < / td >
< td class = "fieldname" >
def< / td >
< td class = "fielddoc" >
event definition < / td > < / tr >
< tr > < td class = "fieldtype" >
< a class = "anchor" id = "ad477a289f1f03ac45407b64268d707d3" > < / a > < a class = "el" href = "group__CMSIS__RTOS__Status.html#gae2e091fefc4c767117727bd5aba4d99e" > osStatus< / a > < / td >
< td class = "fieldname" >
status< / td >
< td class = "fielddoc" >
status code: event or error information < / td > < / tr >
< tr > < td class = "fieldtype" >
< a class = "anchor" id = "a0b9f8fd3645f01d8cb09cae82add2d7f" > < / a > union < a class = "el" href = "group__CMSIS__RTOS__Definitions.html#unionosEvent_8value" > osEvent< / a > < / td >
< td class = "fieldname" >
value< / td >
< td class = "fielddoc" >
event value < / td > < / tr >
< / table >
2019-05-15 10:57:06 +01:00
< / div >
< / div >
2019-10-18 15:30:02 +01:00
< a name = "unionosEvent_8value" id = "unionosEvent_8value" > < / a >
2019-05-15 10:57:06 +01:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2019-10-18 15:30:02 +01:00
< td class = "memname" > union osEvent.value< / td >
2019-05-15 10:57:06 +01:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2019-10-18 15:30:02 +01:00
< div class = "textblock" > < / div > < table class = "fieldtable" >
< tr > < th colspan = "3" > Data Fields< / th > < / tr >
< tr > < td class = "fieldtype" >
< a class = "anchor" id = "a83878c91171338902e0fe0fb97a8c47a" > < / a > void *< / td >
< td class = "fieldname" >
p< / td >
< td class = "fielddoc" >
message or mail as void pointer < / td > < / tr >
< tr > < td class = "fieldtype" >
< a class = "anchor" id = "aa8420f8bebd6d9578b405b6bbaa813d9" > < / a > int32_t< / td >
< td class = "fieldname" >
signals< / td >
< td class = "fielddoc" >
signal flags < / td > < / tr >
< tr > < td class = "fieldtype" >
< a class = "anchor" id = "a9e3669d19b675bd57058fd4664205d2a" > < / a > uint32_t< / td >
< td class = "fieldname" >
v< / td >
< td class = "fielddoc" >
message as 32-bit value < / td > < / tr >
< / table >
2019-05-15 10:57:06 +01:00
< / div >
< / div >
2019-10-18 15:30:02 +01:00
< a name = "unionosEvent_8def" id = "unionosEvent_8def" > < / a >
2019-05-15 10:57:06 +01:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2019-10-18 15:30:02 +01:00
< td class = "memname" > union osEvent.def< / td >
2019-05-15 10:57:06 +01:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2019-10-18 15:30:02 +01:00
< div class = "textblock" > < / div > < table class = "fieldtable" >
< tr > < th colspan = "3" > Data Fields< / th > < / tr >
< tr > < td class = "fieldtype" >
< a class = "anchor" id = "a57aa2b69577037fb2428bc48a9fb1038" > < / a > < a class = "el" href = "cmsis__os_8h.html#a1dac049fb7725a8af8b26c71cbb373b5" > osMailQId< / a > < / td >
< td class = "fieldname" >
mail_id< / td >
< td class = "fielddoc" >
mail id obtained by < a class = "el" href = "group__CMSIS__RTOS__Mail.html#gaa177e7fe5820dd70d8c9e46ded131174" > osMailCreate< / a > < / td > < / tr >
< tr > < td class = "fieldtype" >
< a class = "anchor" id = "a4ccaa172acbdcbf38fa0ea0ef0229c49" > < / a > < a class = "el" href = "cmsis__os_8h.html#ad9ec70c32c6c521970636b521e12d17f" > osMessageQId< / a > < / td >
< td class = "fieldname" >
message_id< / td >
< td class = "fielddoc" >
message id obtained by < a class = "el" href = "group__CMSIS__RTOS__Message.html#gaf3b9345cf426304d46565152bc26fb78" > osMessageCreate< / a > < / td > < / tr >
< / table >
2019-05-15 10:57:06 +01:00
< / div >
< / div >
2019-10-18 15:30:02 +01:00
< a name = "structos__mailQ" id = "structos__mailQ" > < / a >
2019-05-15 10:57:06 +01:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2019-10-18 15:30:02 +01:00
< td class = "memname" > struct os_mailQ< / td >
2019-05-15 10:57:06 +01:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2019-10-18 15:30:02 +01:00
< div class = "textblock" > < p > The < b > < a class = "el" href = "group__CMSIS__RTOS__Definitions.html#structosEvent" title = "Event structure contains detailed information about an event. " > osEvent< / a > < / b > structure describes the events returned by CMSIS-RTOS functions. < / p >
< / div >
2019-05-15 10:57:06 +01:00
< / div >
< / div >
< / div > <!-- contents -->
< / div > <!-- doc - content -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
2019-10-18 15:30:02 +01:00
< li class = "footer" > Generated on Wed Aug 1 2018 17:12:43 for CMSIS-RTOS by Arm Ltd. All rights reserved.
2019-05-15 10:57:06 +01:00
<!--
< a href = "http://www.doxygen.org/index.html" >
2019-10-18 15:30:02 +01:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" / > < / a > 1.8.6
2019-05-15 10:57:06 +01:00
-->
< / li >
< / ul >
< / div >
< / body >
< / html >
