summaryrefslogtreecommitdiffstats
path: root/doc/html/ObjectHeader.txt
diff options
context:
space:
mode:
authorQuincey Koziol <koziol@hdfgroup.org>1998-07-08 14:54:54 (GMT)
committerQuincey Koziol <koziol@hdfgroup.org>1998-07-08 14:54:54 (GMT)
commitbd1e676c521d881b3143829f493a28b5ced1294b (patch)
tree69c50f9fe21ce87f293d8617a6bd51b4cc1e0244 /doc/html/ObjectHeader.txt
parent73345095897d9698bb1f2f7df830bf80a56dc65a (diff)
downloadhdf5-bd1e676c521d881b3143829f493a28b5ced1294b.zip
hdf5-bd1e676c521d881b3143829f493a28b5ced1294b.tar.gz
hdf5-bd1e676c521d881b3143829f493a28b5ced1294b.tar.bz2
[svn-r467] Restructuring documentation.
Diffstat (limited to 'doc/html/ObjectHeader.txt')
-rw-r--r--doc/html/ObjectHeader.txt60
1 files changed, 60 insertions, 0 deletions
diff --git a/doc/html/ObjectHeader.txt b/doc/html/ObjectHeader.txt
new file mode 100644
index 0000000..d769377
--- /dev/null
+++ b/doc/html/ObjectHeader.txt
@@ -0,0 +1,60 @@
+OBJECT HEADERS
+--------------
+
+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 */
+
+
+