Please, help us to better serve our user community by answering the following short survey: https://www.hdfgroup.org/website-survey/
HDF5 1.14.5
API Reference
Loading...
Searching...
No Matches
Fortran Group (H5G) Interface

Detailed Description

See also
Groups (H5G), C-API
HDF5 Groups, User Guide

Modules

module  h5g
 This module contains Fortran interfaces for H5G functions.
 

Functions/Subroutines

subroutine h5gcreate_f (loc_id, name, grp_id, hdferr, size_hint, lcpl_id, gcpl_id, gapl_id)
 Creates a new group.
 
subroutine h5gcreate_async_f (loc_id, name, grp_id, es_id, hdferr, size_hint, lcpl_id, gcpl_id, gapl_id, file, func, line)
 Asynchronously creates a new group.
 
subroutine h5gopen_f (loc_id, name, grp_id, hdferr, gapl_id)
 Opens an existing group.
 
subroutine h5gopen_async_f (loc_id, name, grp_id, es_id, hdferr, gapl_id, file, func, line)
 Asynchronously opens an existing group.
 
subroutine h5gclose_f (grp_id, hdferr)
 Closes the specified group.
 
subroutine h5gclose_async_f (grp_id, es_id, hdferr, file, func, line)
 Asynchronously closes the specified group.
 
subroutine h5gget_obj_info_idx_f (loc_id, name, idx, obj_name, obj_type, hdferr)
 Returns name and type of the group member identified by its index.
 
subroutine h5gn_members_f (loc_id, name, nmembers, hdferr)
 Returns the number of group members.
 
subroutine h5glink_f (loc_id, link_type, current_name, new_name, hdferr)
 Creates a link of the specified type from new_name to current_name.
 
subroutine h5glink2_f (cur_loc_id, cur_name, link_type, new_loc_id, new_name, hdferr)
 Creates a link of the specified type from new_name to current_name. current_name and new_name are interpreted relative to current and new location identifiers.
 
subroutine h5gunlink_f (loc_id, name, hdferr)
 Removes the specified name from the group graph and decrements the link count for the object to which name points.
 
subroutine h5gmove_f (loc_id, name, new_name, hdferr)
 Renames an object within an HDF5 file.
 
subroutine h5gmove2_f (src_loc_id, src_name, dst_loc_id, dst_name, hdferr)
 Renames an object within an HDF5 file.
 
subroutine h5gget_linkval_f (loc_id, name, size, buffer, hdferr)
 Returns the name of the object that the symbolic link points to.
 
subroutine h5gset_comment_f (loc_id, name, comment, hdferr)
 Sets comment for specified object.
 
subroutine h5gget_comment_f (loc_id, name, size, buffer, hdferr)
 Retrieves comment for specified object.
 
subroutine h5gcreate_anon_f (loc_id, grp_id, hdferr, gcpl_id, gapl_id)
 Creates a new empty group without linking it into the file structure.
 
subroutine h5gget_create_plist_f (grp_id, gcpl_id, hdferr)
 Gets a group creation property list identifier.
 
subroutine h5gget_info_f (loc_id, ginfo, hdferr)
 Retrieves information about a group.
 
subroutine h5gget_info_async_f (loc_id, ginfo, es_id, hdferr, file, func, line)
 Asynchronously retrieves information about a group.
 
subroutine h5gget_info_f (loc_id, storage_type, nlinks, max_corder, hdferr, mounted)
 Retrieves information about a group.
 
subroutine h5gget_info_by_idx_f (loc_id, group_name, idx_type, order, n, ginfo, hdferr, lapl_id)
 Retrieves information about a group, according to the group's position within an index.
 
subroutine h5gget_info_by_idx_async_f (loc_id, group_name, idx_type, order, n, ginfo, es_id, hdferr, lapl_id, file, func, line)
 Asynchronously retrieves information about a group, according to the group's position within an index.
 
subroutine h5gget_info_by_idx_f (loc_id, group_name, idx_type, order, n, storage_type, nlinks, max_corder, hdferr, lapl_id, mounted)
 Retrieves information about a group, according to the group's position within an index.
 
subroutine h5gget_info_by_name_f (loc_id, name, ginfo, hdferr, lapl_id)
 Retrieves information about a group by its name.
 
subroutine h5gget_info_by_name_async_f (loc_id, name, ginfo, es_id, hdferr, lapl_id, file, func, line)
 Asynchronously retrieves information about a group by its name.
 
subroutine h5gget_info_by_name_f (loc_id, name, storage_type, nlinks, max_corder, hdferr, lapl_id, mounted)
 Retrieves information about a group by its name.
 

Variables

integer h5g_unknown_f
 H5G_UNKNOWN.
 
integer h5g_group_f
 H5G_GROUP.
 
integer h5g_dataset_f
 H5G_DATASET.
 
integer h5g_type_f
 H5G_TYPE.
 
integer h5g_link_f
 H5G_LINK.
 
integer h5g_udlink_f
 H5G_UDLINK.
 
integer h5g_same_loc_f
 H5G_SAME_LOC.
 
integer h5g_link_error_f
 H5G_LINK_ERROR.
 
integer h5g_link_hard_f
 H5G_LINK_HARD.
 
integer h5g_link_soft_f
 H5G_LINK_SOFT.
 
integer h5g_storage_type_unknown_f
 H5G_STORAGE_TYPE_UNKNOWN.
 
integer h5g_storage_type_symbol_table_f
 H5G_STORAGE_TYPE_SYMBOL_TABLE.
 
integer h5g_storage_type_compact_f
 H5G_STORAGE_TYPE_COMPACT.
 
integer h5g_storage_type_dense_f
 H5G_STORAGE_TYPE_DENSE.
 

Function/Subroutine Documentation

◆ h5gclose_async_f()

subroutine h5gclose_async_f ( integer(hid_t), intent(in)  grp_id,
integer(hid_t), intent(in)  es_id,
integer, intent(out)  hdferr,
type(c_ptr), intent(in), optional  file,
type(c_ptr), intent(in), optional  func,
integer, intent(in), optional  line 
)

Asynchronously closes the specified group.

Parameters
grp_idGroup identifier.
es_idEvent set identifier
hdferrReturns 0 if successful and -1 if it fails.
filePointer to filename the async subroutine is being called from, filename must be null character terminated
funcPointer to function name the async subroutine is being called in, func must be null character terminated
lineLine number the async subroutine is being called at

See C API: H5Gclose_async()

◆ h5gclose_f()

subroutine h5gclose_f ( integer(hid_t), intent(in)  grp_id,
integer, intent(out)  hdferr 
)

Closes the specified group.

Parameters
grp_idGroup identifier.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Gclose()

◆ h5gcreate_anon_f()

subroutine h5gcreate_anon_f ( integer(hid_t), intent(in)  loc_id,
integer(hid_t), intent(out)  grp_id,
integer, intent(out)  hdferr,
integer(hid_t), intent(in), optional  gcpl_id,
integer(hid_t), intent(in), optional  gapl_id 
)

Creates a new empty group without linking it into the file structure.

Parameters
loc_idLocation identifier.
grp_idGroup identifier.
hdferrReturns 0 if successful and -1 if it fails.
gcpl_idGroup creation property list identifier.
gapl_idGroup access property list identifier.

See C API: H5Gcreate_anon()

◆ h5gcreate_async_f()

subroutine h5gcreate_async_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  name,
integer(hid_t), intent(out)  grp_id,
integer(hid_t), intent(in)  es_id,
integer, intent(out)  hdferr,
integer(size_t), intent(in), optional  size_hint,
integer(hid_t), intent(in), optional  lcpl_id,
integer(hid_t), intent(in), optional  gcpl_id,
integer(hid_t), intent(in), optional  gapl_id,
type(c_ptr), intent(in), optional  file,
type(c_ptr), intent(in), optional  func,
integer, intent(in), optional  line 
)

Asynchronously creates a new group.

Parameters
loc_idLocation identifier.
nameGroup name at the specified location.
grp_idGroup identifier.
es_idEvent set identifier
hdferrReturns 0 if successful and -1 if it fails.
size_hintA parameter indicating the number of bytes to reserve for the names that will appear in the group. Set to OBJECT_NAMELEN_DEFAULT_F if using any of the optional parameters lcpl_id, gcpl_id, and/or gapl_id when not using keywords in specifying the optional parameters. See H5Gcreate1().
lcpl_idProperty list for link creation.
gcpl_idProperty list for group creation.
gapl_idProperty list for group access.
filePointer to filename the async subroutine is being called from, filename must be null character terminated
funcPointer to function name the async subroutine is being called in, func must be null character terminated
lineLine number the async subroutine is being called at

See C API: H5Gcreate_async()

◆ h5gcreate_f()

subroutine h5gcreate_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  name,
integer(hid_t), intent(out)  grp_id,
integer, intent(out)  hdferr,
integer(size_t), intent(in), optional  size_hint,
integer(hid_t), intent(in), optional  lcpl_id,
integer(hid_t), intent(in), optional  gcpl_id,
integer(hid_t), intent(in), optional  gapl_id 
)

Creates a new group.

Parameters
loc_idLocation identifier.
nameGroup name at the specified location.
grp_idGroup identifier.
hdferrReturns 0 if successful and -1 if it fails.
size_hintA parameter indicating the number of bytes to reserve for the names that will appear in the group. Set to OBJECT_NAMELEN_DEFAULT_F if using any of the optional parameters lcpl_id, gcpl_id, and/or gapl_id when not using keywords in specifying the optional parameters. See H5Gcreate1().
lcpl_idProperty list for link creation.
gcpl_idProperty list for group creation.
gapl_idProperty list for group access.

See C API: H5Gcreate2()

◆ h5gget_comment_f()

subroutine h5gget_comment_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  name,
integer(size_t), intent(in)  size,
character(len=size), intent(out)  buffer,
integer, intent(out)  hdferr 
)

Retrieves comment for specified object.

Parameters
loc_idLocation identifier.
nameName of the object at specified location.
sizeSize of the buffer required to hold comment.
bufferBuffer to hold object's comment.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Gget_comment()

◆ h5gget_create_plist_f()

subroutine h5gget_create_plist_f ( integer(hid_t), intent(in)  grp_id,
integer(hid_t), intent(out)  gcpl_id,
integer, intent(out)  hdferr 
)

Gets a group creation property list identifier.

Parameters
grp_idGroup identifier.
gcpl_idGroup creation property list identifier.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Gget_create_plist()

◆ h5gget_info_async_f()

subroutine h5gget_info_async_f ( integer(hid_t), intent(in)  loc_id,
type(h5g_info_t), intent(out), target  ginfo,
integer(hid_t), intent(in)  es_id,
integer, intent(out)  hdferr,
type(c_ptr), intent(in), optional  file,
type(c_ptr), intent(in), optional  func,
integer, intent(in), optional  line 
)

Asynchronously retrieves information about a group.

Parameters
loc_idLocation identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute.
ginfoDerived type in which group information is returned.
es_idEvent set identifier
hdferrReturns 0 if successful and -1 if it fails.
filePointer to filename the async subroutine is being called from, filename must be null character terminated
funcPointer to function name the async subroutine is being called in, func must be null character terminated
lineLine number the async subroutine is being called at

See C API: H5Gget_info_async()

◆ h5gget_info_by_idx_async_f()

subroutine h5gget_info_by_idx_async_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  group_name,
integer, intent(in)  idx_type,
integer, intent(in)  order,
integer(hsize_t), intent(in)  n,
type(h5g_info_t), intent(out), target  ginfo,
integer(hid_t), intent(in)  es_id,
integer, intent(out)  hdferr,
integer(hid_t), intent(in), optional  lapl_id,
type(c_ptr), intent(in), optional  file,
type(c_ptr), intent(in), optional  func,
integer, intent(in), optional  line 
)

Asynchronously retrieves information about a group, according to the group's position within an index.

Parameters
loc_idLocation identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute.
group_nameName of group containing group for which information is to be retrieved.
idx_typeIndex type.
orderOrder of the count in the index.
nPosition in the index of the group for which information is retrieved.
ginfoDerived type in which group information is returned.
es_idEvent set identifier
hdferrReturns 0 if successful and -1 if it fails.
lapl_idLink access property list.
filePointer to filename the async subroutine is being called from, filename must be null character terminated
funcPointer to function name the async subroutine is being called in, func must be null character terminated
lineLine number the async subroutine is being called at

See C API: H5Gget_info_by_idx_async()

◆ h5gget_info_by_idx_f() [1/2]

subroutine h5gget_info_by_idx_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  group_name,
integer, intent(in)  idx_type,
integer, intent(in)  order,
integer(hsize_t), intent(in)  n,
type(h5g_info_t), intent(out), target  ginfo,
integer, intent(out)  hdferr,
integer(hid_t), intent(in), optional  lapl_id 
)

Retrieves information about a group, according to the group's position within an index.

Attention
The preferred API, Fortran 2003 version.
Parameters
loc_idLocation identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute.
group_nameName of group containing group for which information is to be retrieved.
idx_typeIndex type.
orderOrder of the count in the index.
nPosition in the index of the group for which information is retrieved.
ginfoDerived type in which group information is returned.
hdferrReturns 0 if successful and -1 if it fails.
lapl_idLink access property list.

See C API: H5Gget_info_by_idx()

◆ h5gget_info_by_idx_f() [2/2]

subroutine h5gget_info_by_idx_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  group_name,
integer, intent(in)  idx_type,
integer, intent(in)  order,
integer(hsize_t), intent(in)  n,
integer, intent(out)  storage_type,
integer, intent(out)  nlinks,
integer, intent(out)  max_corder,
integer, intent(out)  hdferr,
integer(hid_t), intent(in), optional  lapl_id,
logical, intent(out), optional  mounted 
)

Retrieves information about a group, according to the group's position within an index.

Attention
Obsolete API, use the Fortran 2003 version instead.. Both nlinks and max_corder can overflow.
Parameters
loc_idFile or group identifier.
group_nameName of group containing group for which information is to be retrieved.
idx_typeIndex type.
orderOrder of the count in the index.
nPosition in the index of the group for which information is retrieved.
storage_typeType of storage for links in group:
  • H5G_STORAGE_TYPE_COMPACT_F: Compact storage
  • H5G_STORAGE_TYPE_DENSE_F: Indexed storage
  • H5G_STORAGE_TYPE_SYMBOL_TABLE_F: Symbol tables, the original HDF5 structure
nlinksNumber of links in group.
max_corderCurrent maximum creation order value for group.
hdferrReturns 0 if successful and -1 if it fails.
lapl_idLink access property list.
mountedWhether group has a file mounted on it.

See C API: H5Gget_info_by_idx()

◆ h5gget_info_by_name_async_f()

subroutine h5gget_info_by_name_async_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  name,
type(h5g_info_t), intent(out), target  ginfo,
integer(hid_t), intent(in)  es_id,
integer, intent(out)  hdferr,
integer(hid_t), intent(in), optional  lapl_id,
type(c_ptr), intent(in), optional  file,
type(c_ptr), intent(in), optional  func,
integer, intent(in), optional  line 
)

Asynchronously retrieves information about a group by its name.

Parameters
loc_idFile or group identifier.
nameName of group containing group for which information is to be retrieved.
ginfoDerived type in which group information is returned.
es_idEvent set identifier
hdferrReturns 0 if successful and -1 if it fails.
lapl_idLink access property list.
filePointer to filename the async subroutine is being called from, filename must be null character terminated
funcPointer to function name the async subroutine is being called in, func must be null character terminated
lineLine number the async subroutine is being called at

See C API: H5Gget_info_by_name_async()

◆ h5gget_info_by_name_f() [1/2]

subroutine h5gget_info_by_name_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  name,
type(h5g_info_t), intent(out), target  ginfo,
integer, intent(out)  hdferr,
integer(hid_t), intent(in), optional  lapl_id 
)

Retrieves information about a group by its name.

Attention
The preferred API, Fortran 2003 version.
Parameters
loc_idFile or group identifier.
nameName of group containing group for which information is to be retrieved.
ginfoDerived type in which group information is returned.
hdferrReturns 0 if successful and -1 if it fails.
lapl_idLink access property list.

See C API: H5Gget_info_by_name()

◆ h5gget_info_by_name_f() [2/2]

subroutine h5gget_info_by_name_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  name,
integer, intent(out)  storage_type,
integer, intent(out)  nlinks,
integer, intent(out)  max_corder,
integer, intent(out)  hdferr,
integer(hid_t), intent(in), optional  lapl_id,
logical, intent(out), optional  mounted 
)

Retrieves information about a group by its name.

Attention
Obsolete API, use the Fortran 2003 version instead.. Both nlinks and max_corder can overflow.
Parameters
loc_idFile or group identifier.
nameName of group containing group for which information is to be retrieved.
storage_typeType of storage for links in group:
  • H5G_STORAGE_TYPE_COMPACT_F: Compact storage
  • H5G_STORAGE_TYPE_DENSE_F: Indexed storage
  • H5G_STORAGE_TYPE_SYMBOL_TABLE_F: Symbol tables, the original HDF5 structure
nlinksNumber of links in group.
max_corderCurrent maximum creation order value for group.
hdferrReturns 0 if successful and -1 if it fails.
lapl_idLink access property list.
mountedWhether group has a file mounted on it.

See C API: H5Gget_info_by_name()

◆ h5gget_info_f() [1/2]

subroutine h5gget_info_f ( integer(hid_t), intent(in)  loc_id,
type(h5g_info_t), intent(out), target  ginfo,
integer, intent(out)  hdferr 
)

Retrieves information about a group.

Attention
The preferred API, Fortran 2003 version.
Parameters
loc_idLocation identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute.
ginfoDerived type in which group information is returned.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Gget_info()

◆ h5gget_info_f() [2/2]

subroutine h5gget_info_f ( integer(hid_t), intent(in)  loc_id,
integer, intent(out)  storage_type,
integer, intent(out)  nlinks,
integer, intent(out)  max_corder,
integer, intent(out)  hdferr,
logical, intent(out), optional  mounted 
)

Retrieves information about a group.

Attention
Obsolete API, use the Fortran 2003 version instead.. Both nlinks and max_corder can overflow.
Parameters
loc_idLocation identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute.
storage_typeType of storage for links in group:
  • H5G_STORAGE_TYPE_COMPACT_F: Compact storage
  • H5G_STORAGE_TYPE_DENSE_F: Indexed storage
  • H5G_STORAGE_TYPE_SYMBOL_TABLE_F: Symbol tables, the original HDF5 structure
nlinksNumber of links in group.
max_corderCurrent maximum creation order value for group.
hdferrReturns 0 if successful and -1 if it fails.
mountedWhether group has a file mounted on it.

See C API: H5Gget_info()

◆ h5gget_linkval_f()

subroutine h5gget_linkval_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  name,
integer(size_t), intent(in)  size,
character(len=size), intent(out)  buffer,
integer, intent(out)  hdferr 
)

Returns the name of the object that the symbolic link points to.

Parameters
loc_idLocation identifier.
nameSymbolic link to the object whose name is to be returned.
sizeMaximum number of characters to be returned.
bufferA buffer to hold the name of the object being sought.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Gget_linkval()

◆ h5gget_obj_info_idx_f()

subroutine h5gget_obj_info_idx_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  name,
integer, intent(in)  idx,
character(len=*), intent(out)  obj_name,
integer, intent(out)  obj_type,
integer, intent(out)  hdferr 
)

Returns name and type of the group member identified by its index.

Parameters
loc_idLocation identifier.
nameName of the group at the specified location.
idxObject index (zero-based).
obj_nameObject name.
obj_typeObject type.
hdferrReturns 0 if successful and -1 if it fails.

◆ h5glink2_f()

subroutine h5glink2_f ( integer(hid_t), intent(in)  cur_loc_id,
character(len=*), intent(in)  cur_name,
integer, intent(in)  link_type,
integer(hid_t), intent(in)  new_loc_id,
character(len=*), intent(in)  new_name,
integer, intent(out)  hdferr 
)

Creates a link of the specified type from new_name to current_name. current_name and new_name are interpreted relative to current and new location identifiers.

Parameters
cur_loc_idLocation identifier.
cur_nameName of the existing object if link is a hard link. Can be anything for the soft link.
link_typeLink type; possible values are:
  • H5G_LINK_HARD_F
  • H5G_LINK_SOFT_F
new_loc_idNew location identifier.
new_nameNew name for the object.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Glink2()

◆ h5glink_f()

subroutine h5glink_f ( integer(hid_t), intent(in)  loc_id,
integer, intent(in)  link_type,
character(len=*), intent(in)  current_name,
character(len=*), intent(in)  new_name,
integer, intent(out)  hdferr 
)

Creates a link of the specified type from new_name to current_name.

Parameters
loc_idLocation identifier.
link_typeLink type; possible values are:
  • H5G_LINK_HARD_F
  • H5G_LINK_SOFT_F
current_nameName of the existing object if link is a hard link. Can be anything for the soft link.
new_nameNew name for the object.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Glink()

◆ h5gmove2_f()

subroutine h5gmove2_f ( integer(hid_t), intent(in)  src_loc_id,
character(len=*), intent(in)  src_name,
integer(hid_t), intent(in)  dst_loc_id,
character(len=*), intent(in)  dst_name,
integer, intent(out)  hdferr 
)

Renames an object within an HDF5 file.

Parameters
src_loc_idOriginal location identifier.
src_nameObject's name at specified original location.
dst_loc_idOriginal location identifier.
dst_nameObject's new name.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Gmove2()

◆ h5gmove_f()

subroutine h5gmove_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  name,
character(len=*), intent(in)  new_name,
integer, intent(out)  hdferr 
)

Renames an object within an HDF5 file.

Parameters
loc_idLocation identifier.
nameObject's name at specified location.
new_nameObject's new name.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Gmove()

◆ h5gn_members_f()

subroutine h5gn_members_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  name,
integer, intent(out)  nmembers,
integer, intent(out)  hdferr 
)

Returns the number of group members.

Parameters
loc_idLocation identifier.
nameName of the group at the specified location.
nmembersNumber of group members.
hdferrReturns 0 if successful and -1 if it fails.

◆ h5gopen_async_f()

subroutine h5gopen_async_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  name,
integer(hid_t), intent(out)  grp_id,
integer(hid_t), intent(in)  es_id,
integer, intent(out)  hdferr,
integer(hid_t), intent(in), optional  gapl_id,
type(c_ptr), intent(in), optional  file,
type(c_ptr), intent(in), optional  func,
integer, intent(in), optional  line 
)

Asynchronously opens an existing group.

Parameters
loc_idLocation identifier.
nameName of the group to open.
grp_idGroup identifier.
es_idEvent set identifier
hdferrReturns 0 if successful and -1 if it fails.
gapl_idGroup access property list identifier.
filePointer to filename the async subroutine is being called from, filename must be null character terminated
funcPointer to function name the async subroutine is being called in, func must be null character terminated
lineLine number the async subroutine is being called at

See C API: H5Gopen_async()

◆ h5gopen_f()

subroutine h5gopen_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  name,
integer(hid_t), intent(out)  grp_id,
integer, intent(out)  hdferr,
integer(hid_t), intent(in), optional  gapl_id 
)

Opens an existing group.

Parameters
loc_idLocation identifier.
nameName of the group to open.
grp_idGroup identifier.
hdferrReturns 0 if successful and -1 if it fails.
gapl_idGroup access property list identifier.

See C API: H5Gopen2()

◆ h5gset_comment_f()

subroutine h5gset_comment_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  name,
character(len=*), intent(in)  comment,
integer, intent(out)  hdferr 
)

Sets comment for specified object.

Parameters
loc_idLocation identifier.
nameName of the object.
commentComment to set for the object.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Gset_comment()

◆ h5gunlink_f()

subroutine h5gunlink_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  name,
integer, intent(out)  hdferr 
)

Removes the specified name from the group graph and decrements the link count for the object to which name points.

Parameters
loc_idLocation identifier.
nameName of the object to unlink.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Gunlink()

Variable Documentation

◆ h5g_dataset_f

integer h5g_dataset_f

H5G_DATASET.

◆ h5g_group_f

integer h5g_group_f

H5G_GROUP.

◆ h5g_link_error_f

integer h5g_link_error_f

H5G_LINK_ERROR.

◆ h5g_link_f

integer h5g_link_f

H5G_LINK.

◆ h5g_link_hard_f

integer h5g_link_hard_f

H5G_LINK_HARD.

◆ h5g_link_soft_f

integer h5g_link_soft_f

H5G_LINK_SOFT.

◆ h5g_same_loc_f

integer h5g_same_loc_f

H5G_SAME_LOC.

◆ h5g_storage_type_compact_f

integer h5g_storage_type_compact_f

H5G_STORAGE_TYPE_COMPACT.

◆ h5g_storage_type_dense_f

integer h5g_storage_type_dense_f

H5G_STORAGE_TYPE_DENSE.

◆ h5g_storage_type_symbol_table_f

integer h5g_storage_type_symbol_table_f

H5G_STORAGE_TYPE_SYMBOL_TABLE.

◆ h5g_storage_type_unknown_f

integer h5g_storage_type_unknown_f

H5G_STORAGE_TYPE_UNKNOWN.

◆ h5g_type_f

integer h5g_type_f

H5G_TYPE.

◆ h5g_udlink_f

integer h5g_udlink_f

H5G_UDLINK.

◆ h5g_unknown_f

integer h5g_unknown_f

H5G_UNKNOWN.