mirror of
https://github.com/HDFGroup/hdf5.git
synced 2025-02-11 16:01:00 +08:00
1091cab2e6
Purpose:
Add short copyright notice.
Update release tag line.
Description:
Added short copyright notice as comment in source files;
does not display in browser.
Updated release tag line in footers to read as follows:
Describes HDF5 Release 1.6.0, July 2003
Platforms tested:
IE 5
385 lines
12 KiB
HTML
385 lines
12 KiB
HTML
<html>
|
|
<head><title>
|
|
FORTRAN Group API -- h5g
|
|
</title>
|
|
|
|
<!-- #BeginLibraryItem "/ed_libs/styles_RM.lbi" -->
|
|
|
|
<!--
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
* 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. *
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
-->
|
|
|
|
<link href="../ed_styles/RMelect.css" rel="stylesheet" type="text/css">
|
|
<!-- #EndLibraryItem --></head>
|
|
|
|
<body bgcolor="#FFFFFF">
|
|
|
|
|
|
|
|
<center>
|
|
<h1>The FORTRAN 90 API to HDF5<br>h5g: Groups</h1>
|
|
</center>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5gclose_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface: <code>h5gclose_f</code></strong>
|
|
<pre>
|
|
SUBROUTINE h5gclose_f( gr_id, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: gr_id ! Group identifier
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5gclose_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5gcreate_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface: <code>h5gcreate_f</code></strong>
|
|
<pre>
|
|
SUBROUTINE h5gcreate_f(loc_id, name, gr_id, hdferr, size_hint)
|
|
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
|
|
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the group to be created
|
|
INTEGER(HID_T), INTENT(OUT) :: gr_id ! Group identifier
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
INTEGER(SIZE_T), OPTIONAL, INTENT(IN) :: size_hint
|
|
! Number of bytes to store the names
|
|
! of objects in the group.
|
|
! Default value is OBJECT_NAMELEN_DEFAULT_F
|
|
END SUBROUTINE h5gcreate_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5gget_comment_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface: <code>h5gget_comment_f</code></strong>
|
|
<pre>
|
|
SUBROUTINE h5gget_comment_f(loc_id, name, size, buffer, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
|
|
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the object link
|
|
CHARACTER(LEN=size), INTENT(OUT) :: buffer ! Buffer to hold a
|
|
! comment
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5gget_comment_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5gget_linkval_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface: <code>h5gget_linkval_f</code></strong>
|
|
<pre>
|
|
SUBROUTINE h5gget_linkval_f(loc_id, name, size, buffer, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
|
|
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the symbolic link
|
|
CHARACTER(LEN=size), INTENT(OUT) :: buffer ! Buffer to hold a
|
|
! name of the object
|
|
! symbolic link points to
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5gget_linkval_f
|
|
</pre>
|
|
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5gget_obj_info_idx_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface: <code>h5gget_obj_info_idx_f</code></strong>
|
|
<pre>
|
|
SUBROUTINE h5gget_obj_info_idx_f(loc_id, name, idx, &
|
|
obj_name, obj_type, hdferr)
|
|
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
|
|
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the group
|
|
INTEGER, INTENT(IN) :: idx ! Index of member object
|
|
CHARACTER(LEN=*), INTENT(OUT) :: obj_name ! Name of the object
|
|
INTEGER, INTENT(OUT) :: obj_type ! Object type :
|
|
! H5G_LINK_F
|
|
! H5G_GROUP_F
|
|
! H5G_DATASET_F
|
|
! H5G_TYPE_F
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
|
|
END SUBROUTINE h5gget_obj_info_idx_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5gmove_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface: <code>h5gmove_f</code></strong>
|
|
<pre>
|
|
SUBROUTINE h5gmove_f(loc_id, name, new_name, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
|
|
CHARACTER(LEN=*), INTENT(IN) :: name ! Original name of an object
|
|
CHARACTER(LEN=*), INTENT(IN) :: new_name ! New name of an object
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5gmove_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5gmove2_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface: <code>h5gmove_f</code></strong>
|
|
<pre>
|
|
SUBROUTINE h5gmove2_f(src_loc_id, src_name, dst_loc_id, dst_name, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: src_loc_id ! File or group identifier
|
|
CHARACTER(LEN=*), INTENT(IN) :: src_name ! Original name of an object
|
|
! relative to src_loc_id
|
|
INTEGER(HID_T), INTENT(IN) :: dst_loc_id ! File or group identifier
|
|
CHARACTER(LEN=*), INTENT(IN) :: dst_name ! New name of an object
|
|
! relative to dst_loc_id
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5gmove2_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5gn_members_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface: <code>h5gn_members_f</code></strong>
|
|
<pre>
|
|
SUBROUTINE h5gn_members_f(loc_id, name, nmembers, hdferr)
|
|
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
|
|
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the group
|
|
INTEGER, INTENT(OUT) :: nmembers ! Number of members in the
|
|
! group
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
|
|
END SUBROUTINE h5gn_members_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5gopen_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface: <code>h5gopen_f</code></strong>
|
|
<pre>
|
|
SUBROUTINE h5gopen_f(loc_id, name, gr_id, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
|
|
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the group to open
|
|
INTEGER(HID_T), INTENT(OUT) :: gr_id ! Group identifier
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5gopen_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5gset_comment_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface: <code>h5gset_comment_f</code></strong>
|
|
<pre>
|
|
SUBROUTINE h5gset_comment_f(loc_id, name, comment, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
|
|
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of object
|
|
CHARACTER(LEN=*), INTENT(IN) :: comment ! Comment for the object
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5gset_comment_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5glink_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5glink_f</strong>
|
|
|
|
<dt><strong>Purpose:</strong>
|
|
Creates a link of the specified type from <code> new_name</code> to <code>current_name</code>.
|
|
|
|
<pre>
|
|
SUBROUTINE h5glink_f(loc_id, link_type, current_name, new_name, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group location identifier
|
|
INTEGER, INTENT(IN) :: link_type ! Link type, possible values are:
|
|
! H5G_LINK_HARD_F
|
|
! H5G_LINK_SOFT_F
|
|
CHARACTER(LEN=*), INTENT(IN) :: current_name ! Current object name relative
|
|
! to loc_id
|
|
CHARACTER(LEN=*), INTENT(IN) :: new_name ! New object name
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
|
|
END SUBROUTINE h5glink_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5glink2_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5glink2_f</strong>
|
|
|
|
<dt><strong>Purpose:</strong>
|
|
Creates a link of the specified type from <code> new_name</code> at location
|
|
<code> new_loc_id,/code> to <code>cur_name</code> at location
|
|
<code>cur_loc_id</code>.
|
|
|
|
<pre>
|
|
SUBROUTINE h5glink2_f(cur_loc_id, cur_name, link_type, new_loc_id, new_name, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: cur_loc_id ! File or group location identifier
|
|
CHARACTER(LEN=*), INTENT(IN) :: cur_name
|
|
! Name of the existing object
|
|
! is relative to cur_loc_id. Can be
|
|
! anything for the soft link.
|
|
INTEGER, INTENT(IN) :: link_type ! Link type, possible values are:
|
|
! H5G_LINK_HARD_F
|
|
! H5G_LINK_SOFT_F
|
|
INTEGER(HID_T), INTENT(IN) :: new_loc_id ! New location identifier
|
|
CHARACTER(LEN=*), INTENT(IN) :: new_name ! New object name
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
|
|
END SUBROUTINE h5glink2_f
|
|
</pre>
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5gunlink_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface: <code>h5gunlink_f</code></strong>
|
|
<pre>
|
|
SUBROUTINE h5gunlink_f(loc_id, name, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
|
|
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the object to unlink
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5gunlink_f
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
|
|
|
|
<!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address>
|
|
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
|
|
<br>
|
|
Describes HDF5 Release 1.6.0, July 2003
|
|
</address><!-- #EndLibraryItem -->
|
|
|
|
Last modified: 5 March 2003
|
|
|
|
</body>
|
|
</html>
|