Rate This Document
Findability
Accuracy
Completeness
Readability

Creating a Group

Function Syntax

Create an empty group with a specified name.

hid_t H5Gcreate2( hid_t parentId, const char *name, hid_t linkCreatePlistId, hid_t createPlistId, hid_t accessPlistId)

Parameters

Parameter

Description

Value Range

Input/Output

parentId

Location identifier, which may be that of a file, group, dataset, named data type, or attribute

Integer

Input

*name

Absolute or relative name of the link to the new group

Non-empty string of less than 256 bytes

Input

linkCreatePlistId

Link creation property list identifier

Integer. The lcpl_id parameter is currently not used. Specify H5P_DEFAULT.

Input

createPlistId

Group creation property list identifier

Integer. The gcpl_id parameter is currently not used. Specify H5P_DEFAULT.

Input

accessPlistId

Group access property list identifier

Integer. The gapl_id parameter is currently not used. Specify H5P_DEFAULT.

Input

Return Value

  • Success: group identifier
  • Failure: negative value