Last modified: 9 October 2014
Name: H5Gcreate2
Signature:
  hid_t `H5Gcreate2`( hid_t `loc_id`, const char *`name`, hid_t `lcpl_id`, hid_t `gcpl_id`, hid_t `gapl_id` )

Purpose:
  Creates a new group and links it into the file.

Description:
  `H5Gcreate2` creates a new group in a file. After a group has been created, links to datasets and to other groups can be added.

  The `loc_id` and `name` parameters specify where the group is located. `loc_id` may be a file identifier or a group identifier in the file. `name` is the link to the group; `name` may be either an absolute path in the file (the links from the root group to the new group) or a relative path from `loc_id` (the link(s) from the group specified by `loc_id` to the new group). See the “Accessing objects by location and name” topic for more information.

  `lcpl_id`, `gcpl_id`, and `gapl_id` are property list identifiers. These property lists govern how the link to the group is created, how the group is created, and how the group can be accessed in the future, respectively. `H5P_DEFAULT` can be passed in if the default properties are appropriate for these property lists. Currently, there are no APIs for the group access property list; use `H5P_DEFAULT`. See “H5P: Property List Interface” for the functions that can be used with each property list.

  To conserve and release resources, the group should be closed when access is no longer required.

Parameters:

  hid_t `loc_id` | IN: File or group identifier
  const char *`name` | IN: Absolute or relative name of the link to the new group
  hid_t `lcpl_id` | IN: Link creation property list identifier
  hid_t `gcpl_id` | IN: Group creation property list identifier
  hid_t `gapl_id` | IN: Group access property list identifier (No group access properties have been implemented at this time; use `H5P_DEFAULT`.)

Returns:
  Returns a group identifier if successful; otherwise returns a negative value.

Fortran90 Interface:
  See listing under `H5Gcreate`.
See Also:
  “Using Identifiers”

History:

  Release | C
  1.8.0 | Function introduced in this release.