libhdf4-doc 4.2r4-12build1 / usr / share / doc / libhdf4 / html-reference / RM_Section_II_HDF.html

This file is indexed.

/usr/share/doc/libhdf4/html-reference/RM_Section_II_HDF.html is in libhdf4-doc 4.2r4-12build1.

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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
<!?xml version="1.0" encoding="ISO-8859-1"?>
<!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" xml:lang="en" lang="en">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
    <meta http-equiv="Content-Style-Type" content="text/css" />
    <meta name="GENERATOR" content="Quadralay WebWorks Publisher 2003 for FrameMaker 8.0.8.2296" />
    <meta name="TEMPLATEBASE" content="Dynamic HTML" />
    <meta name="LASTUPDATED" content="07/05/09 22:30:18" />
    <title>HDFclose/hdfclose</title>
    <link rel="StyleSheet" href="document.css" type="text/css" media="all" />
    <link rel="StyleSheet" href="catalog.css" type="text/css" media="all" />
<link rel="first" title="First" href="RM_Front.html" />
<link rel="last" title="Last" href="RM_Copyright.html" />
<link rel="previous" title="Previous" href="RM_Section_II_H_Adv.html" />
<link rel="next" title="Next" href="RM_Section_II_HE.html" />

    <script type="text/javascript" language="JavaScript1.2" src="scripts/expand.js"></script>
    <script type="text/javascript" language="JavaScript1.2" src="scripts/seealso.js"></script>

    <script type="text/javascript" language="JavaScript1.2">
     <!--
      var  WebWorksSeeAlso = new WebWorksSeeAlso_Object();
     // -->
    </script>
  </head>

  <body>

    <p>

    <table id="SummaryNotReq1" border="0" width="610"cellspacing="0" cellpadding="0">
      <tr>

        <td align="left">
          <img id="LongDescNotReq1" border="0"src="images/hdf_logo.jpg" width="90" height="70" alt="The HDF Group" valign="top" />
        </td>
        <td valign="middle" align="center">
          <b><H1>HDF Reference Manual</H1></b>
	</td>
      </tr>
    </table>

    </p>
    <hr />

    <blockquote>
<a name="wp422002"> </a><h2 class="pRef_HDF_RoutineName">
<p align=right><A HREF="RM_Section_II_HDFLOP.html">
[HDF Interface]</A><a HREF="RMTOP.html"><b>[Top]</b></a>
</p>
<hr />
HDFclose/hdfclose
</h2>
<a name="wp422004"> </a><p style="font-weight: normal" class="pSignature">
intn HDFclose(int32 <span style="color: #000000; font-style: italic; font-variant: normal; font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline" class="cDefault">file_id</span>)
</p>
<a name="wp443767"> </a><p class="pBodyRelative">
</p>
<div align="left">
<table border="0" cellpadding="2" cellspacing="8" bgcolor="White" id="wp441039table441037">
  <caption></caption>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441039"> </a><div style="margin-top: 0pt" class="pCellVariable">
<span style="color: #000000; font-style: italic; font-variant: normal; font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline" class="cDefault">file_id</span>
</div>
</td>
    <td><a name="wp441041"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
IN:
</div>
</td>
    <td><a name="wp441043"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
File identifier returned by <b class="cFunctionName">Hopen</b>
</div>
</td>
</tr>
</table>
</div>
<p class="pBodyRelative">
</p>
<div align="left">
<table border="0" cellpadding="2" cellspacing="8" bgcolor="White" id="wp441046table441044">
  <caption></caption>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441046"> </a><div style="font-style: normal; margin-bottom: 0pt; margin-top: 0pt; text-transform: none" class="pCellHeadingWW">
Purpose
</div></td>
    <td><a name="wp441048"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
Closes the access path to the file.
</div>
</td>
</tr>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441050"> </a><div style="font-style: normal; margin-bottom: 0pt; margin-top: 0pt; text-transform: none" class="pCellHeadingWW">
Return value
</div></td>
    <td><a name="wp441052"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
Returns <code style="font-family: Courier New; font-size: 8pt" class="cDefName">SUCCEED</code> (or <span style="color: #000000; font-style: normal; font-variant: normal; font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline" class="cDefault">0</span>) if successful and <code style="font-family: Courier New; font-size: 8pt" class="cDefName">FAIL</code> (or <span style="color: #000000; font-style: normal; font-variant: normal; font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline" class="cDefault">-1</span>) otherwise.
</div>
</td>
</tr>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441054"> </a><div style="font-style: normal; margin-bottom: 0pt; margin-top: 0pt; text-transform: none" class="pCellHeadingWW">
Description
</div></td>
    <td><a name="wp441056"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
The file identifier <span style="color: #000000; font-style: italic; font-variant: normal; font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline" class="cDefault">file_id</span> is validated before the file is closed. If the identifier is valid, the function closes the access path to the file.
</div>
</td>
</tr>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441058"> </a><div style="font-style: normal; margin-bottom: 0pt; margin-top: 0pt; text-transform: none" class="pCellHeadingWW">
&#160;
</div></td>
    <td><a name="wp441062"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
If there are still access identifiers attached to the file, the error code <span style="color: #000000; font-style: normal; font-variant: normal; font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline" class="cDefault">DFE_OPENAID</span> is returned and the file is not closed. This is a common occurrence when developing new interfaces. See <b class="cFunctionName">Hendaccess</b> for further discussion of this problem.
</div>
</td>
</tr>
</table>
</div>
<p class="pBodyRelative">
</p>
<div align="left">
<table border="0" cellpadding="2" cellspacing="8" bgcolor="White" id="wp441067table441065">
  <caption></caption>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441067"> </a><div style="font-style: normal; margin-bottom: 0pt; margin-top: 0pt; text-transform: none" class="pCellHeadingWW">
FORTRAN
</div></td>
    <td><a name="wp441069"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellFortSyntax">
integer function hdfclose(file_id)
</div>
</td>
</tr>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441075"> </a><div style="font-style: normal; margin-bottom: 0pt; margin-top: 0pt; text-transform: none" class="pCellHeadingWW">
&#160;
</div></td>
    <td><a name="wp441077"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellFortVar">
integer file_id
</div>
</td>
</tr>
</table>
</div>
<p class="pBodyRelative">

</p>
<a name="wp422029"> </a><h2 class="pRef_HDF_RoutineName">
<p align=right><A HREF="RM_Section_II_HDFLOP.html">
[HDF Interface]</A><a HREF="RMTOP.html"><b>[Top]</b></a>
</p>
<hr />
HDFopen/hdfopen
</h2>
<a name="wp422031"> </a><p style="font-weight: normal" class="pSignature">
int32 HDFopen(char *<span style="color: #000000; font-style: italic; font-variant: normal; font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline" class="cDefault">filename</span>, intn <span style="color: #000000; font-style: italic; font-variant: normal; font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline" class="cDefault">access</span>, int16 <span style="color: #000000; font-style: italic; font-variant: normal; font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline" class="cDefault">n_dds</span>)
</p>
<a name="wp443915"> </a><p class="pBodyRelative">
</p>
<div align="left">
<table border="0" cellpadding="2" cellspacing="8" bgcolor="White" id="wp441084table441082">
  <caption></caption>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441084"> </a><div style="margin-top: 0pt" class="pCellVariable">
filename
</div>
</td>
    <td><a name="wp441086"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
IN:
</div>
</td>
    <td><a name="wp441088"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
Complete path and filename for the file to be opened
</div>
</td>
</tr>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441090"> </a><div style="margin-top: 0pt" class="pCellVariable">
access
</div>
</td>
    <td><a name="wp441092"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
IN:
</div>
</td>
    <td><a name="wp441094"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
File access code
</div>
</td>
</tr>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441096"> </a><div style="margin-top: 0pt" class="pCellVariable">
n_dds
</div>
</td>
    <td><a name="wp441098"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
IN:
</div>
</td>
    <td><a name="wp441100"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
Number of data descriptors in a block if a new file is to be created
</div>
</td>
</tr>
</table>
</div>
<p class="pBodyRelative">
</p>
<div align="left">
<table border="0" cellpadding="2" cellspacing="8" bgcolor="White" id="wp441103table441101">
  <caption></caption>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441103"> </a><div style="font-style: normal; margin-bottom: 0pt; margin-top: 0pt; text-transform: none" class="pCellHeadingWW">
Purpose
</div></td>
    <td><a name="wp441105"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
Provides an access path to an HDF file by reading all the data descriptor blocks into memory.
</div>
</td>
</tr>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441107"> </a><div style="font-style: normal; margin-bottom: 0pt; margin-top: 0pt; text-transform: none" class="pCellHeadingWW">
Return value
</div></td>
    <td><a name="wp441109"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
Returns the file identifier if successful and <code style="font-family: Courier New; font-size: 8pt" class="cDefName">FAIL</code> (or <span style="color: #000000; font-style: normal; font-variant: normal; font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline" class="cDefault">-1</span>) otherwise.
</div>
</td>
</tr>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441111"> </a><div style="font-style: normal; margin-bottom: 0pt; margin-top: 0pt; text-transform: none" class="pCellHeadingWW">
Description
</div></td>
    <td><a name="wp441113"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
If given a new file name, <b class="cFunctionName">HDFopen</b> will create a new file using the specified access type and number of data descriptors. If given an existing file name, <b class="cFunctionName">HDFopen</b> will open the file using the specified access type and ignore the <span style="color: #000000; font-style: italic; font-variant: normal; font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline" class="cDefault">n_dds</span> argument.
</div>
</td>
</tr>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441115"> </a><div style="font-style: normal; margin-bottom: 0pt; margin-top: 0pt; text-transform: none" class="pCellHeadingWW">
&#160;
</div></td>
    <td><a name="wp441125"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
HDF provides several file access code definitions:
</div>
</td>
</tr>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441360"> </a><div style="font-style: normal; margin-bottom: 0pt; margin-top: 0pt; text-transform: none" class="pCellHeadingWW">
&#160;
</div></td>
    <td><a name="wp441362"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
DFACC_READ - Open for read only. If file does not exist, an error condition results.
</div>
<a name="wp441367"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
DFACC_CREATE - If file exists, delete it, then open a new file for read/write.
</div>
<a name="wp441372"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
DFACC_WRITE - Open for read/write. If file does not exist, create it.
</div>
</td>
</tr>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441386"> </a><div style="font-style: normal; margin-bottom: 0pt; margin-top: 0pt; text-transform: none" class="pCellHeadingWW">
&#160;
</div></td>
    <td><a name="wp441388"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
If a file is opened and an attempt is made to reopen the file using <span style="color: #000000; font-style: normal; font-variant: normal; font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline" class="cDefault">DFACC_CREATE</span>, HDF will issue the error <span style="color: #000000; font-style: normal; font-variant: normal; font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline" class="cDefault">DFE_ALROPEN</span>. If the file is opened with read only access and an attempt is made to reopen the file for write access using <span style="color: #000000; font-style: normal; font-variant: normal; font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline" class="cDefault">DFACC_RDWR</span>, <span style="color: #000000; font-style: normal; font-variant: normal; font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline" class="cDefault">DFACC_WRITE</span>, or <span style="color: #000000; font-style: normal; font-variant: normal; font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline" class="cDefault">DFACC_ALL</span>, HDF will attempt to reopen the file with read and write permissions.
</div>
</td>
</tr>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441390"> </a><div style="font-style: normal; margin-bottom: 0pt; margin-top: 0pt; text-transform: none" class="pCellHeadingWW">
&#160;
</div></td>
    <td><a name="wp441392"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellDescription">
Upon successful exit, the named file is opened with the relevant permissions, the data descriptors are set up in memory, and the associated <span style="color: #000000; font-style: italic; font-variant: normal; font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline" class="cDefault">file_id</span> is returned. For new files, the appropriate file headers are also set up.
</div>
</td>
</tr>
</table>
</div>
<p class="pBodyRelative">
</p>
<div align="left">
<table border="0" cellpadding="2" cellspacing="8" bgcolor="White" id="wp441144table441142">
  <caption></caption>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441144"> </a><div style="font-style: normal; margin-bottom: 0pt; margin-top: 0pt; text-transform: none" class="pCellHeadingWW">
FORTRAN
</div></td>
    <td><a name="wp441146"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellFortSyntax">
integer function hdfopen(filename, access, n_dds)
</div>
</td>
</tr>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441152"> </a><div style="font-style: normal; margin-bottom: 0pt; margin-top: 0pt; text-transform: none" class="pCellHeadingWW">
&#160;
</div></td>
    <td><a name="wp441154"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellFortVar">
character*(*) filename
</div>
</td>
</tr>
  <tr align="left" valign="top">    <td><td nowrap>
<a name="wp441156"> </a><div style="font-style: normal; margin-bottom: 0pt; margin-top: 0pt; text-transform: none" class="pCellHeadingWW">
&#160;
</div></td>
    <td><a name="wp441158"> </a><div style="margin-bottom: 0pt; margin-top: 0pt" class="pCellFortVar">
integer access, n_dds
</div>
</td>
</tr>
</table>
</div>
<p class="pBodyRelative">

</p>
    </blockquote>

    <hr />

    <table id="SummaryNotReq2" border="0" width="850" cellspacing="0" cellpadding="0">
      <tr>
        <td align="left">
        HDF4.2r4 - February 2009<br/>
        <a href="RM_Copyright.html">Copyright</a>
        <td align="right">
          <span style="font-size: 12px; font-weight: bold">
            The HDF Group<br />
          </span>
          <span style="font-size: 12px">
            <a href="http://www.hdfgroup.org">www.hdfgroup.org</a><br />
            <img valign="bottom" border="0" src="images/help.jpg" height="12" alt="The HDF Group" valign="top" />
          </span>
        </td>
      </tr>
    </table>

    <table id="SummaryNotReq3" width="220" border="0" cellpadding="0" cellspacing="0">
    </table>
  </body>
</html>

APT Browse - Built by Thomas Orozco.