/usr/share/doc/libepr-api-dev/html/group__REC.html is in libepr-api-dev 2.3~dev20150708-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ENVISAT Product Reader C API: Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="custom.css" rel="stylesheet" type="text/css">
</head><body>
<table class="header">
<tr class="header">
<td class="header">
ENVISAT Product Reader API for C
</td>
<td class="header" align="right">
<a href="http://www.brockmann-consult.de/beam">
<img src="../images/beam_header.gif" width="227" height="29" border="0">
</a>
</td>
</tr>
</table>
<br>
<!--<div class="navigation">-->
<!--<div class="tabs">-->
<!--<ul>-->
<!--<li class="current"><a href="index.html"><span>API Details</span></a></li>-->
<!--<li><a href="overview_custom.html"><span>API Overview</span></a></li>-->
<!--</ul>-->
<!--</div>-->
<!--</div>-->
<!-- Generated by Doxygen 1.8.9.1 -->
<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>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Record Access<div class="ingroups"><a class="el" href="group__DA.html">Basic Data Access</a></div></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:gaea835a4878afa724476bf8fb90816b53"><td class="memItemLeft" align="right" valign="top"><a class="el" href="epr__api_8h.html#a640112c6b205b2448f22bbc5f5ebaa66">EPR_SRecord</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__REC.html#gaea835a4878afa724476bf8fb90816b53">epr_create_record</a> (<a class="el" href="epr__api_8h.html#a71cc87fc4dcd5ecf806afd115359c07e">EPR_SDatasetId</a> *dataset_id)</td></tr>
<tr class="memdesc:gaea835a4878afa724476bf8fb90816b53"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new, empty record with a structure compatible with the dataset specified by dataset_id. <a href="#gaea835a4878afa724476bf8fb90816b53">More...</a><br /></td></tr>
<tr class="separator:gaea835a4878afa724476bf8fb90816b53"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf02e24257c6abf41d9fab518e36dc12b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="epr__api_8h.html#a640112c6b205b2448f22bbc5f5ebaa66">EPR_SRecord</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__REC.html#gaf02e24257c6abf41d9fab518e36dc12b">epr_read_record</a> (<a class="el" href="epr__api_8h.html#a71cc87fc4dcd5ecf806afd115359c07e">EPR_SDatasetId</a> *dataset_id, <a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> record_index, <a class="el" href="epr__api_8h.html#a640112c6b205b2448f22bbc5f5ebaa66">EPR_SRecord</a> *record)</td></tr>
<tr class="memdesc:gaf02e24257c6abf41d9fab518e36dc12b"><td class="mdescLeft"> </td><td class="mdescRight">Reads a record of a dataset specified by dataset_id. <a href="#gaf02e24257c6abf41d9fab518e36dc12b">More...</a><br /></td></tr>
<tr class="separator:gaf02e24257c6abf41d9fab518e36dc12b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab1f3e7878c99ebd3d1c1935e7f63acde"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__REC.html#gab1f3e7878c99ebd3d1c1935e7f63acde">epr_free_record</a> (<a class="el" href="epr__api_8h.html#a640112c6b205b2448f22bbc5f5ebaa66">EPR_SRecord</a> *record)</td></tr>
<tr class="memdesc:gab1f3e7878c99ebd3d1c1935e7f63acde"><td class="mdescLeft"> </td><td class="mdescRight">Frees the memory allocated through the given record. <a href="#gab1f3e7878c99ebd3d1c1935e7f63acde">More...</a><br /></td></tr>
<tr class="separator:gab1f3e7878c99ebd3d1c1935e7f63acde"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaea835a4878afa724476bf8fb90816b53"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="epr__api_8h.html#a640112c6b205b2448f22bbc5f5ebaa66">EPR_SRecord</a>* epr_create_record </td>
<td>(</td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a71cc87fc4dcd5ecf806afd115359c07e">EPR_SDatasetId</a> * </td>
<td class="paramname"><em>dataset_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new, empty record with a structure compatible with the dataset specified by dataset_id. </p>
<p>Such a record is typically used in subsequent calls to epr_read_record.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dataset_id</td><td>the dataset identifier, must not be <code>NULL</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the new record instance or <code>NULL</code> if an error occured. </dd></dl>
</div>
</div>
<a class="anchor" id="gaf02e24257c6abf41d9fab518e36dc12b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="epr__api_8h.html#a640112c6b205b2448f22bbc5f5ebaa66">EPR_SRecord</a>* epr_read_record </td>
<td>(</td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a71cc87fc4dcd5ecf806afd115359c07e">EPR_SDatasetId</a> * </td>
<td class="paramname"><em>dataset_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"><em>record_index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a640112c6b205b2448f22bbc5f5ebaa66">EPR_SRecord</a> * </td>
<td class="paramname"><em>record</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a record of a dataset specified by dataset_id. </p>
<p>The record is identified through the given dataset identifier and the given zero-based record index. In order to reduce memory reallocation, a record (pre-) created by the function <code>epr_create_record</code> can be passed to this function. Data is then read into this given record. If no record (<code>NULL</code>) is given, the function initiates a new one. In both cases, the record in which the data is read into will be returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dataset_id</td><td>the dataset identifier, must not be <code>NULL</code> </td></tr>
<tr><td class="paramname">record_index</td><td>the zero-based record index </td></tr>
<tr><td class="paramname">record</td><td>a pre-created record to reduce memory reallocation, can be <code>NULL</code> to let the function allocate a new record </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the record in which the data has been read into or <code>NULL</code> if an error occured. </dd></dl>
</div>
</div>
<a class="anchor" id="gab1f3e7878c99ebd3d1c1935e7f63acde"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void epr_free_record </td>
<td>(</td>
<td class="paramtype"><a class="el" href="epr__api_8h.html#a640112c6b205b2448f22bbc5f5ebaa66">EPR_SRecord</a> * </td>
<td class="paramname"><em>record</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees the memory allocated through the given record. </p>
<p>After calling this function the given record pointer becomes invalid and should not be used anymore. </p>
</div>
</div>
</div><!-- contents -->
<hr>
<div align="center">
<address>
<p>Generated on Thu Jul 9 2015 05:15:51
<p>ENVISAT Product Reader C API
<p>Written by
<a href="mailto:info@brockmann-consult.de">Brockmann Consult</a>,
© 2002
<a href="http://www.brockmann-consult.de/">
<img src="../images/bc_logo.gif" alt="Brockmann Consult" align="bottom" border=0 width=18 height=18>
</a>
<a href="http://envisat.esa.int/">
<img src="../images/esa_logo.gif" alt="Eropean Space Agency" align="bottom" border=0 width=50 height=18>
</a>
</address>
</div>
</body>
</html>
|