summaryrefslogtreecommitdiffstats
path: root/doc/html/TechNotes/ObjectHeader.html
blob: 5c6ada0230a7b07ed8a19ac2eb6bc34eb160c54c (plain)
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
<html>
<body>

<!-- #BeginLibraryItem "/ed_libs/copyright-html.lbi" -->
<!-- separator -->
<!--
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  * Copyright by the Board of Trustees of the University of Illinois.         *
  * All rights reserved.                                                      *
  *                                                                           *
  * This file is part of HDF5.  The full HDF5 copyright notice, including     *
  * terms governing use, modification, and redistribution, is contained in    *
  * the files COPYING and Copyright.html.  COPYING can be found at the root   *
  * of the source code distribution tree; Copyright.html can be found at the  *
  * root level of an installed copy of the electronic HDF5 document set and   *
  * is linked from the top-level documents page.  It can also be found at     *
  * http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html.  If you do not have     *
  * access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 -->
<!-- separator -->
<!-- #EndLibraryItem -->

<h1>Object Headers</h1>

<pre>

haddr_t
H5O_new (hdf5_file_t *f, intn nrefs, size_t size_hint)

	Creates a new empty object header and returns its address.
	The SIZE_HINT is the initial size of the data portion of the
	object header and NREFS is the number of symbol table entries
	that reference this object header (normally one).

	If SIZE_HINT is too small, then at least some default amount
	of space is allocated for the object header.

intn				        /*num remaining links		*/
H5O_link (hdf5_file_t *f,		/*file containing header	*/
	  haddr_t addr,			/*header file address		*/
	  intn adjust)			/*link adjustment amount	*/


size_t
H5O_sizeof (hdf5_file_t *f,		/*file containing header	*/
	    haddr_t addr,		/*header file address		*/
            H5O_class_t *type,		/*message type or H5O_ANY	*/
	    intn sequence)		/*sequence number, usually zero	*/
		
	Returns the size of a particular instance of a message in an
	object header.  When an object header has more than one
	instance of a particular message type, then SEQUENCE indicates
	which instance to return.

void *
H5O_read (hdf5_file_t *f,		/*file containing header	*/
	  haddr_t addr,			/*header file address		*/
	  H5G_entry_t *ent,		/*optional symbol table entry	*/
	  H5O_class_t *type,		/*message type or H5O_ANY	*/
	  intn sequence,		/*sequence number, usually zero	*/
	  size_t size,			/*size of output message	*/
	  void *mesg)			/*output buffer			*/

	Reads a message from the object header into memory.

const void *
H5O_peek (hdf5_file_t *f,		/*file containing header	*/
          haddr_t addr,			/*header file address		*/
	  H5G_entry_t *ent,		/*optional symbol table entry	*/
	  H5O_class_t *type,		/*type of message or H5O_ANY	*/
	  intn sequence)		/*sequence number, usually zero	*/

haddr_t					/*new heap address		*/
H5O_modify (hdf5_file_t *f,		/*file containing header	*/
            haddr_t addr,		/*header file address		*/
	    H5G_entry_t *ent,		/*optional symbol table entry	*/
	    hbool_t *ent_modified,	/*entry modification flag	*/
	    H5O_class_t *type,		/*message type			*/
	    intn overwrite,		/*sequence number or -1		*/
	    void *mesg)			/*the message			*/  
	  

===========================================
Last Modified:  8 July 1998 (technical content)
Last Modified:  28 April 2000 (included in HDF5 Technical Notes)
HDF Help Desk:  hdfhelp@ncsa.uiuc.edu

</pre>

</body>
</html>