core
/
eccodes
mirror of https://github.com/ecmwf/eccodes.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
eccodes/html/group__handling__coded__mes...

125 lines
6.2 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>grib_api: Handling coded messages</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<h1>Handling coded messages</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__handling__coded__messages.html#g9d654bd4fc5f422c161edd0a140ea185">grib_get_message</a> (<a class="el" href="group__grib__handle.html#g309a5ee24f4c730646d3f80ad0ef5f1b">grib_handle</a> *h, const void **message, size_t *message_length)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">getting the message attached to a handle <a href="#g9d654bd4fc5f422c161edd0a140ea185"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__handling__coded__messages.html#g9248c021d985da70cfeb075e469db874">grib_get_message_copy</a> (<a class="el" href="group__grib__handle.html#g309a5ee24f4c730646d3f80ad0ef5f1b">grib_handle</a> *h, void *message, size_t *message_length)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">getting a copy of the message attached to a handle <a href="#g9248c021d985da70cfeb075e469db874"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g9d654bd4fc5f422c161edd0a140ea185"></a><!-- doxytag: member="grib_api.h::grib_get_message" ref="g9d654bd4fc5f422c161edd0a140ea185" args="(grib_handle *h, const void **message, size_t *message_length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grib_get_message </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__grib__handle.html#g309a5ee24f4c730646d3f80ad0ef5f1b">grib_handle</a> *&nbsp;</td>
<td class="paramname"> <em>h</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void **&nbsp;</td>
<td class="paramname"> <em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t *&nbsp;</td>
<td class="paramname"> <em>message_length</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
getting the message attached to a handle
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>h</em>&nbsp;</td><td>: the grib handle to wich the buffer should be gathered </td></tr>
<tr><td valign="top"></td><td valign="top"><em>message</em>&nbsp;</td><td>: the pointer to be set to the handle's data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>message_length</em>&nbsp;</td><td>: at exist, the message size in number of bytes </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if OK, integer value on error </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="precision_8c-example.html#a6">precision.c</a>, and <a class="el" href="set_8c-example.html#a5">set.c</a>.</dl>
</div>
</div><p>
<a class="anchor" name="g9248c021d985da70cfeb075e469db874"></a><!-- doxytag: member="grib_api.h::grib_get_message_copy" ref="g9248c021d985da70cfeb075e469db874" args="(grib_handle *h, void *message, size_t *message_length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grib_get_message_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__grib__handle.html#g309a5ee24f4c730646d3f80ad0ef5f1b">grib_handle</a> *&nbsp;</td>
<td class="paramname"> <em>h</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t *&nbsp;</td>
<td class="paramname"> <em>message_length</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
getting a copy of the message attached to a handle
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>h</em>&nbsp;</td><td>: the grib handle to wich the buffer should be returned </td></tr>
<tr><td valign="top"></td><td valign="top"><em>message</em>&nbsp;</td><td>: the pointer to the data buffer to be filled </td></tr>
<tr><td valign="top"></td><td valign="top"><em>message_length</em>&nbsp;</td><td>: at entry, the size in number of bytes of the allocated empty message. At exist, the actual message length in number of bytes </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 if OK, integer value on error </dd></dl>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 22 15:18:22 2009 for grib_api by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink