mirror of https://github.com/ecmwf/eccodes.git
365 lines
20 KiB
HTML
365 lines
20 KiB
HTML
|
<!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: Iterating on keys names</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 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 Pages</span></a></li>
|
||
|
|
<li><a href="examples.html"><span>Examples</span></a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<h1>Iterating on keys names</h1><table border="0" cellpadding="0" cellspacing="0">
|
||
|
|
<tr><td></td></tr>
|
||
|
|
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keys__iterator.html#g0e4d2d943ddd61d0b877060e6fbea405">GRIB_KEYS_ITERATOR_ALL_KEYS</a> 0</td></tr>
|
||
|
|
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keys__iterator.html#g22b6978a432db7211a270438077f7062">GRIB_KEYS_ITERATOR_SKIP_READ_ONLY</a> (1<<0)</td></tr>
|
||
|
|
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keys__iterator.html#ge665875b6303dab2265bbb088c723860">GRIB_KEYS_ITERATOR_SKIP_OPTIONAL</a> (1<<1)</td></tr>
|
||
|
|
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keys__iterator.html#g37ad0fca3eb784fed7e2b4a44e1ca2b6">GRIB_KEYS_ITERATOR_SKIP_EDITION_SPECIFIC</a> (1<<2)</td></tr>
|
||
|
|
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keys__iterator.html#g52ad3f33022d82a46cd80cb99a1307ff">GRIB_KEYS_ITERATOR_SKIP_CODED</a> (1<<3)</td></tr>
|
||
|
|
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keys__iterator.html#g26fe182483e385904cc68695b1c42131">GRIB_KEYS_ITERATOR_SKIP_COMPUTED</a> (1<<4)</td></tr>
|
||
|
|
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keys__iterator.html#ge64e8f24f3094903d6a686a213f92e4e">GRIB_KEYS_ITERATOR_SKIP_DUPLICATES</a> (1<<5)</td></tr>
|
||
|
|
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keys__iterator.html#gcbef496e484e5e18c799f74dd5cdfff7">GRIB_KEYS_ITERATOR_SKIP_FUNCTION</a> (1<<6)</td></tr>
|
||
|
|
|
||
|
|
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct <br>
|
||
|
|
<a class="el" href="group__keys__iterator.html#gfa22412541f9d2df9680a82371036dbb">grib_keys_iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keys__iterator.html#gfa22412541f9d2df9680a82371036dbb">grib_keys_iterator</a></td></tr>
|
||
|
|
|
||
|
|
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__keys__iterator.html#gfa22412541f9d2df9680a82371036dbb">grib_keys_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keys__iterator.html#g66a11d157fc81e1c27fc2acad0a5b1f4">grib_keys_iterator_new</a> (<a class="el" href="group__grib__handle.html#g309a5ee24f4c730646d3f80ad0ef5f1b">grib_handle</a> *h, unsigned long filter_flags, char *name_space)</td></tr>
|
||
|
|
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keys__iterator.html#g28f6ac808ecdc324fa3a47bc7b3f6dec">grib_keys_iterator_next</a> (<a class="el" href="group__keys__iterator.html#gfa22412541f9d2df9680a82371036dbb">grib_keys_iterator</a> *kiter)</td></tr>
|
||
|
|
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keys__iterator.html#gec3348471f770965c07964e286249e12">grib_keys_iterator_get_name</a> (<a class="el" href="group__keys__iterator.html#gfa22412541f9d2df9680a82371036dbb">grib_keys_iterator</a> *kiter)</td></tr>
|
||
|
|
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keys__iterator.html#g79716d2b701c3dbb3d3a8e633f35a40a">grib_keys_iterator_delete</a> (<a class="el" href="group__keys__iterator.html#gfa22412541f9d2df9680a82371036dbb">grib_keys_iterator</a> *kiter)</td></tr>
|
||
|
|
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keys__iterator.html#g15ceb24c7b8ac673d948ccdaf1ba5fd6">grib_keys_iterator_rewind</a> (<a class="el" href="group__keys__iterator.html#gfa22412541f9d2df9680a82371036dbb">grib_keys_iterator</a> *kiter)</td></tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||
|
|
The keys iterator is designed to get the key names defined in a message. Key names on which the iteration is carried out can be filtered through their attributes or by the namespace they belong to. <hr><h2>Define Documentation</h2>
|
||
|
|
<a class="anchor" name="g0e4d2d943ddd61d0b877060e6fbea405"></a><!-- doxytag: member="grib_api.h::GRIB_KEYS_ITERATOR_ALL_KEYS" ref="g0e4d2d943ddd61d0b877060e6fbea405" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define GRIB_KEYS_ITERATOR_ALL_KEYS 0 </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Iteration is carried out on all the keys available in the message<p>
|
||
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__keys__iterator.html#g66a11d157fc81e1c27fc2acad0a5b1f4">grib_keys_iterator_new</a> </dd></dl>
|
||
|
|
<dl compact><dt><b>Examples: </b></dt><dd>
|
||
|
|
<a class="el" href="keys__iterator_8c-example.html#a0">keys_iterator.c</a>.</dl>
|
||
|
|
</div>
|
||
|
|
</div><p>
|
||
|
|
<a class="anchor" name="g52ad3f33022d82a46cd80cb99a1307ff"></a><!-- doxytag: member="grib_api.h::GRIB_KEYS_ITERATOR_SKIP_CODED" ref="g52ad3f33022d82a46cd80cb99a1307ff" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define GRIB_KEYS_ITERATOR_SKIP_CODED (1<<3) </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
coded keys are skipped by keys iterator.<p>
|
||
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__keys__iterator.html#g66a11d157fc81e1c27fc2acad0a5b1f4">grib_keys_iterator_new</a> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div><p>
|
||
|
|
<a class="anchor" name="g26fe182483e385904cc68695b1c42131"></a><!-- doxytag: member="grib_api.h::GRIB_KEYS_ITERATOR_SKIP_COMPUTED" ref="g26fe182483e385904cc68695b1c42131" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define GRIB_KEYS_ITERATOR_SKIP_COMPUTED (1<<4) </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
computed keys are skipped by keys iterator.<p>
|
||
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__keys__iterator.html#g66a11d157fc81e1c27fc2acad0a5b1f4">grib_keys_iterator_new</a> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div><p>
|
||
|
|
<a class="anchor" name="ge64e8f24f3094903d6a686a213f92e4e"></a><!-- doxytag: member="grib_api.h::GRIB_KEYS_ITERATOR_SKIP_DUPLICATES" ref="ge64e8f24f3094903d6a686a213f92e4e" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define GRIB_KEYS_ITERATOR_SKIP_DUPLICATES (1<<5) </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
duplicates of a key are skipped by keys iterator.<p>
|
||
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__keys__iterator.html#g66a11d157fc81e1c27fc2acad0a5b1f4">grib_keys_iterator_new</a> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div><p>
|
||
|
|
<a class="anchor" name="g37ad0fca3eb784fed7e2b4a44e1ca2b6"></a><!-- doxytag: member="grib_api.h::GRIB_KEYS_ITERATOR_SKIP_EDITION_SPECIFIC" ref="g37ad0fca3eb784fed7e2b4a44e1ca2b6" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define GRIB_KEYS_ITERATOR_SKIP_EDITION_SPECIFIC (1<<2) </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
edition specific keys are skipped by keys iterator.<p>
|
||
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__keys__iterator.html#g66a11d157fc81e1c27fc2acad0a5b1f4">grib_keys_iterator_new</a> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div><p>
|
||
|
|
<a class="anchor" name="gcbef496e484e5e18c799f74dd5cdfff7"></a><!-- doxytag: member="grib_api.h::GRIB_KEYS_ITERATOR_SKIP_FUNCTION" ref="gcbef496e484e5e18c799f74dd5cdfff7" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define GRIB_KEYS_ITERATOR_SKIP_FUNCTION (1<<6) </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
function keys are skipped by keys iterator.<p>
|
||
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__keys__iterator.html#g66a11d157fc81e1c27fc2acad0a5b1f4">grib_keys_iterator_new</a> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div><p>
|
||
|
|
<a class="anchor" name="ge665875b6303dab2265bbb088c723860"></a><!-- doxytag: member="grib_api.h::GRIB_KEYS_ITERATOR_SKIP_OPTIONAL" ref="ge665875b6303dab2265bbb088c723860" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define GRIB_KEYS_ITERATOR_SKIP_OPTIONAL (1<<1) </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
optional keys are skipped by keys iterator.<p>
|
||
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__keys__iterator.html#g66a11d157fc81e1c27fc2acad0a5b1f4">grib_keys_iterator_new</a> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div><p>
|
||
|
|
<a class="anchor" name="g22b6978a432db7211a270438077f7062"></a><!-- doxytag: member="grib_api.h::GRIB_KEYS_ITERATOR_SKIP_READ_ONLY" ref="g22b6978a432db7211a270438077f7062" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">#define GRIB_KEYS_ITERATOR_SKIP_READ_ONLY (1<<0) </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
read only keys are skipped by keys iterator.<p>
|
||
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__keys__iterator.html#g66a11d157fc81e1c27fc2acad0a5b1f4">grib_keys_iterator_new</a> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div><p>
|
||
|
|
<hr><h2>Typedef Documentation</h2>
|
||
|
|
<a class="anchor" name="gfa22412541f9d2df9680a82371036dbb"></a><!-- doxytag: member="grib_api.h::grib_keys_iterator" ref="gfa22412541f9d2df9680a82371036dbb" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">typedef struct <a class="el" href="group__keys__iterator.html#gfa22412541f9d2df9680a82371036dbb">grib_keys_iterator</a> <a class="el" href="group__keys__iterator.html#gfa22412541f9d2df9680a82371036dbb">grib_keys_iterator</a> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Grib keys iterator. Iterator over keys. <dl compact><dt><b>Examples: </b></dt><dd>
|
||
|
|
<a class="el" href="keys__iterator_8c-example.html#a2">keys_iterator.c</a>, and <a class="el" href="keys__iterator__fortran_8_f-example.html#a0">keys_iterator_fortran.F</a>.</dl>
|
||
|
|
</div>
|
||
|
|
</div><p>
|
||
|
|
<hr><h2>Function Documentation</h2>
|
||
|
|
<a class="anchor" name="g79716d2b701c3dbb3d3a8e633f35a40a"></a><!-- doxytag: member="grib_api.h::grib_keys_iterator_delete" ref="g79716d2b701c3dbb3d3a8e633f35a40a" args="(grib_keys_iterator *kiter)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int grib_keys_iterator_delete </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="group__keys__iterator.html#gfa22412541f9d2df9680a82371036dbb">grib_keys_iterator</a> * </td>
|
||
|
|
<td class="paramname"> <em>kiter</em> </td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td width="100%"></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Delete the iterator. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>kiter</em> </td><td>: valid grib_keys_iterator </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="keys__iterator_8c-example.html#a8">keys_iterator.c</a>, <a class="el" href="keys__iterator_8f90-example.html#a4">keys_iterator.f90</a>, and <a class="el" href="keys__iterator__fortran_8_f-example.html#a4">keys_iterator_fortran.F</a>.</dl>
|
||
|
|
</div>
|
||
|
|
</div><p>
|
||
|
|
<a class="anchor" name="gec3348471f770965c07964e286249e12"></a><!-- doxytag: member="grib_api.h::grib_keys_iterator_get_name" ref="gec3348471f770965c07964e286249e12" args="(grib_keys_iterator *kiter)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const char* grib_keys_iterator_get_name </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="group__keys__iterator.html#gfa22412541f9d2df9680a82371036dbb">grib_keys_iterator</a> * </td>
|
||
|
|
<td class="paramname"> <em>kiter</em> </td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td width="100%"></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
get the key name from the iterator <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>kiter</em> </td><td>: valid grib_keys_iterator </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>key name </dd></dl>
|
||
|
|
<dl compact><dt><b>Examples: </b></dt><dd>
|
||
|
|
<a class="el" href="keys__iterator_8c-example.html#a6">keys_iterator.c</a>, <a class="el" href="keys__iterator_8f90-example.html#a3">keys_iterator.f90</a>, and <a class="el" href="keys__iterator__fortran_8_f-example.html#a2">keys_iterator_fortran.F</a>.</dl>
|
||
|
|
</div>
|
||
|
|
</div><p>
|
||
|
|
<a class="anchor" name="g66a11d157fc81e1c27fc2acad0a5b1f4"></a><!-- doxytag: member="grib_api.h::grib_keys_iterator_new" ref="g66a11d157fc81e1c27fc2acad0a5b1f4" args="(grib_handle *h, unsigned long filter_flags, char *name_space)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="group__keys__iterator.html#gfa22412541f9d2df9680a82371036dbb">grib_keys_iterator</a>* grib_keys_iterator_new </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="group__grib__handle.html#g309a5ee24f4c730646d3f80ad0ef5f1b">grib_handle</a> * </td>
|
||
|
|
<td class="paramname"> <em>h</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">unsigned long </td>
|
||
|
|
<td class="paramname"> <em>filter_flags</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">char * </td>
|
||
|
|
<td class="paramname"> <em>name_space</em></td><td> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td><td width="100%"></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Create a new iterator from a valid and initialized handle. <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> </td><td>: the handle whose keys you want to iterate </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>filter_flags</em> </td><td>: flags to filter out some of the keys through their attributes </td></tr>
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>name_space</em> </td><td>: if not null the iteration is carried out only on keys belongin to the namespace passed. (NULL for all the keys) </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>keys iterator ready to iterate through keys according to filter_flags and namespace </dd></dl>
|
||
|
|
<dl compact><dt><b>Examples: </b></dt><dd>
|
||
|
|
<a class="el" href="keys__iterator_8c-example.html#a4">keys_iterator.c</a>, and <a class="el" href="keys__iterator_8f90-example.html#a1">keys_iterator.f90</a>.</dl>
|
||
|
|
</div>
|
||
|
|
</div><p>
|
||
|
|
<a class="anchor" name="g28f6ac808ecdc324fa3a47bc7b3f6dec"></a><!-- doxytag: member="grib_api.h::grib_keys_iterator_next" ref="g28f6ac808ecdc324fa3a47bc7b3f6dec" args="(grib_keys_iterator *kiter)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int grib_keys_iterator_next </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="group__keys__iterator.html#gfa22412541f9d2df9680a82371036dbb">grib_keys_iterator</a> * </td>
|
||
|
|
<td class="paramname"> <em>kiter</em> </td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td width="100%"></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Step to the next iterator. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>kiter</em> </td><td>: valid grib_keys_iterator </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 if next iterator exitsts, 0 if no more elements to iterate on </dd></dl>
|
||
|
|
<dl compact><dt><b>Examples: </b></dt><dd>
|
||
|
|
<a class="el" href="keys__iterator_8c-example.html#a5">keys_iterator.c</a>, <a class="el" href="keys__iterator_8f90-example.html#a2">keys_iterator.f90</a>, and <a class="el" href="keys__iterator__fortran_8_f-example.html#a1">keys_iterator_fortran.F</a>.</dl>
|
||
|
|
</div>
|
||
|
|
</div><p>
|
||
|
|
<a class="anchor" name="g15ceb24c7b8ac673d948ccdaf1ba5fd6"></a><!-- doxytag: member="grib_api.h::grib_keys_iterator_rewind" ref="g15ceb24c7b8ac673d948ccdaf1ba5fd6" args="(grib_keys_iterator *kiter)" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int grib_keys_iterator_rewind </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="group__keys__iterator.html#gfa22412541f9d2df9680a82371036dbb">grib_keys_iterator</a> * </td>
|
||
|
|
<td class="paramname"> <em>kiter</em> </td>
|
||
|
|
<td> ) </td>
|
||
|
|
<td width="100%"></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Rewind the iterator. <dl compact><dt><b>Parameters:</b></dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign="top"></td><td valign="top"><em>kiter</em> </td><td>: valid grib_keys_iterator </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
|
||
|
|
<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>
|