2016-08-25 17:32:08 +00: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" / >
< meta name = "generator" content = "Doxygen 1.8.5" / >
< title > eccodes: Handling coded messages< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / 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 >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / 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: 56px;" >
< td style = "padding-left: 0.5em;" >
< div id = "projectname" > eccodes
< / div >
< / td >
< / tr >
< / tbody >
< / table >
2013-04-02 14:02:10 +00:00
< / div >
2016-08-25 17:32:08 +00:00
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
< 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 = "modules.html" > < span > C  Interface< / span > < / a > < / li >
< li > < a href = "classeccodes.html" > < span > F90  Interface< / span > < / a > < / li >
< li > < a href = "namespaces.html" > < span > Python  Interface< / 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 -->
<!-- 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 > Namespaces< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(3)" > < span class = "SelectionMark" >   < / span > Files< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(4)" > < span class = "SelectionMark" >   < / span > Functions< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(5)" > < span class = "SelectionMark" >   < / span > Groups< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(6)" > < span class = "SelectionMark" >   < / span > Pages< / a > < / div >
2013-04-02 14:02:10 +00:00
2016-08-25 17:32:08 +00:00
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< iframe src = "javascript:void(0)" frameborder = "0"
name="MSearchResults" id="MSearchResults">
< / iframe >
< / div >
2013-04-02 14:02:10 +00:00
2016-08-25 17:32:08 +00:00
< div class = "header" >
< div class = "summary" >
< a href = "#func-members" > Functions< / a > < / div >
< div class = "headertitle" >
< div class = "title" > Handling coded messages< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
< tr class = "memitem:ga3d6f22a666e8e8dd7b33c98f2a7f3f62" > < td class = "memItemLeft" align = "right" valign = "top" > int  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__handling__coded__messages.html#ga3d6f22a666e8e8dd7b33c98f2a7f3f62" > codes_get_message< / a > (< a class = "el" href = "structcodes__handle.html" > codes_handle< / a > *h, const void **message, size_t *message_length)< / td > < / tr >
< tr class = "memdesc:ga3d6f22a666e8e8dd7b33c98f2a7f3f62" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > getting the message attached to a handle < a href = "#ga3d6f22a666e8e8dd7b33c98f2a7f3f62" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga3d6f22a666e8e8dd7b33c98f2a7f3f62" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga8b2cb8c072b886de83a8e089c004a630" > < td class = "memItemLeft" align = "right" valign = "top" > int  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__handling__coded__messages.html#ga8b2cb8c072b886de83a8e089c004a630" > codes_get_message_copy< / a > (< a class = "el" href = "structcodes__handle.html" > codes_handle< / a > *h, void *message, size_t *message_length)< / td > < / tr >
< tr class = "memdesc:ga8b2cb8c072b886de83a8e089c004a630" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > getting a copy of the message attached to a handle < a href = "#ga8b2cb8c072b886de83a8e089c004a630" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga8b2cb8c072b886de83a8e089c004a630" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2013-04-02 14:02:10 +00:00
< / table >
2016-08-25 17:32:08 +00:00
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< h2 class = "groupheader" > Function Documentation< / h2 >
< a class = "anchor" id = "ga3d6f22a666e8e8dd7b33c98f2a7f3f62" > < / a >
2013-04-02 14:02:10 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2016-08-25 17:32:08 +00:00
< td class = "memname" > int codes_get_message < / td >
2013-04-02 14:02:10 +00:00
< td > (< / td >
2016-08-25 17:32:08 +00:00
< td class = "paramtype" > < a class = "el" href = "structcodes__handle.html" > codes_handle< / a > *  < / td >
< td class = "paramname" > < em > h< / em > , < / td >
2013-04-02 14:02:10 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2016-08-25 17:32:08 +00:00
< td class = "paramtype" > const void **  < / td >
< td class = "paramname" > < em > message< / em > , < / td >
2013-04-02 14:02:10 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2016-08-25 17:32:08 +00:00
< td class = "paramtype" > size_t *  < / td >
< td class = "paramname" > < em > message_length< / em >   < / td >
2013-04-02 14:02:10 +00:00
< / tr >
< tr >
< td > < / td >
< td > )< / td >
2016-08-25 17:32:08 +00:00
< td > < / td > < td > < / td >
2013-04-02 14:02:10 +00:00
< / tr >
< / table >
2016-08-25 17:32:08 +00:00
< / div > < div class = "memdoc" >
2013-04-02 14:02:10 +00:00
2016-08-25 17:32:08 +00:00
< p > getting the message attached to a handle < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > h< / td > < td > : the handle to which the buffer should be gathered < / td > < / tr >
< tr > < td class = "paramname" > message< / td > < td > : the pointer to be set to the handle's data < / td > < / tr >
< tr > < td class = "paramname" > message_length< / td > < td > : On exit, the message size in number of bytes < / td > < / tr >
2013-04-02 14:02:10 +00:00
< / table >
2016-08-25 17:32:08 +00:00
< / dd >
2013-04-02 14:02:10 +00:00
< / dl >
2016-08-25 17:32:08 +00:00
< dl class = "section return" > < dt > Returns< / dt > < dd > 0 if OK, integer value on error < / dd > < / dl >
2013-04-02 14:02:10 +00:00
< / div >
2016-08-25 17:32:08 +00:00
< / div >
< a class = "anchor" id = "ga8b2cb8c072b886de83a8e089c004a630" > < / a >
2013-04-02 14:02:10 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2016-08-25 17:32:08 +00:00
< td class = "memname" > int codes_get_message_copy < / td >
2013-04-02 14:02:10 +00:00
< td > (< / td >
2016-08-25 17:32:08 +00:00
< td class = "paramtype" > < a class = "el" href = "structcodes__handle.html" > codes_handle< / a > *  < / td >
< td class = "paramname" > < em > h< / em > , < / td >
2013-04-02 14:02:10 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2016-08-25 17:32:08 +00:00
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > message< / em > , < / td >
2013-04-02 14:02:10 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2016-08-25 17:32:08 +00:00
< td class = "paramtype" > size_t *  < / td >
< td class = "paramname" > < em > message_length< / em >   < / td >
2013-04-02 14:02:10 +00:00
< / tr >
< tr >
< td > < / td >
< td > )< / td >
2016-08-25 17:32:08 +00:00
< td > < / td > < td > < / td >
2013-04-02 14:02:10 +00:00
< / tr >
< / table >
2016-08-25 17:32:08 +00:00
< / div > < div class = "memdoc" >
2013-04-02 14:02:10 +00:00
2016-08-25 17:32:08 +00:00
< p > getting a copy of the message attached to a handle < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > h< / td > < td > : the handle to which the buffer should be returned < / td > < / tr >
< tr > < td class = "paramname" > message< / td > < td > : the pointer to the data buffer to be filled < / td > < / tr >
< tr > < td class = "paramname" > message_length< / td > < td > : On entry, the size in number of bytes of the allocated empty message. On exit, the actual message length in number of bytes < / td > < / tr >
2013-04-02 14:02:10 +00:00
< / table >
2016-08-25 17:32:08 +00:00
< / dd >
2013-04-02 14:02:10 +00:00
< / dl >
2016-08-25 17:32:08 +00:00
< dl class = "section return" > < dt > Returns< / dt > < dd > 0 if OK, integer value on error < / dd > < / dl >
2013-04-02 14:02:10 +00:00
< / div >
2016-08-25 17:32:08 +00:00
< / div >
< / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
Generated by   < a href = "http://www.doxygen.org/index.html" >
< img class = "footer" src = "doxygen.png" alt = "doxygen" / >
< / a > 1.8.5
< / small > < / address >
2013-04-02 14:02:10 +00:00
< / body >
< / html >
