ddn.lib.hdf5.h5g

HDF5 Group Binding

This module provides D bindings for HDF5 group operations (H5G API).

License

BSD-3-Clause

enum H5G_link_t H5G_obj_t H5G_storage_type_t

fn H5Gclose H5Gcreate1 H5Gcreate2 H5Gcreate_anon H5Gflush H5Gget_comment H5Gget_create_plist H5Gget_info H5Gget_info_by_idx H5Gget_info_by_name H5Gget_linkval H5Gget_num_objs H5Gget_objinfo H5Gget_objname_by_idx H5Gget_objtype_by_idx H5Giterate H5Glink H5Glink2 H5Gmove H5Gmove2 H5Gopen1 H5Gopen2 H5Grefresh H5Gset_comment H5Gunlink

Types 6

enumH5G_storage_type_t : int

Group storage type

UNKNOWN = - 1

SYMBOL_TABLE = 0

COMPACT = 1

DENSE = 2

structH5G_info_t

Group information structure

Fields

H5G_storage_type_t storage_type

hsize_t nlinks

long max_corder

hbool_t mounted

enumH5G_obj_t : int

Object types for legacy group iteration.

Used by H5Gget_objtype_by_idx and related deprecated functions.

UNKNOWN = - 1Unknown object type

GROUP = 0Group object

DATASET = 1Dataset object

TYPE = 2Named datatype object

LINK = 3Soft link

UDLINK = 4User-defined link

RESERVED_5 = 5Reserved for future use

RESERVED_6 = 6Reserved for future use

RESERVED_7 = 7Reserved for future use

enumH5G_link_t : int

Link type for legacy H5Glink functions.

ERROR = - 1Error

HARD = 0Hard link

SOFT = 1Soft link

structH5G_stat_t

Object stat structure (deprecated).

Contains information about an object returned by H5Gget_objinfo.

Fields

ulong[2] filenoFile number (low word)

ulong[2] objnoObject number (low word)

uint nlinkNumber of hard links to object

H5G_obj_t typeObject type

long mtimeModification time

size_t linklenSymbolic link value size

H5O_hdr_info_t ohdrObject header information

aliasH5G_iterate_t = herr_t function(hid_t group, const char * name, void * op_data)

Callback function type for H5Giterate.

Parameters

`group`	Group identifier
`name`	Name of the object
`op_data`	User data passed to H5Giterate

Returns

Zero to continue iteration, positive to stop iteration successfully,

negative to stop iteration with an error.

Functions 25

fnhid_t H5Gcreate2(hid_t loc_id, const char * name, hid_t lcpl_id, hid_t gcpl_id, hid_t gapl_id)Creates a new group

fnhid_t H5Gcreate_anon(hid_t loc_id, hid_t gcpl_id, hid_t gapl_id)Creates an anonymous group

fnhid_t H5Gopen2(hid_t loc_id, const char * name, hid_t gapl_id)Opens an existing group

fnherr_t H5Gclose(hid_t group_id)Closes a group

fnhid_t H5Gget_create_plist(hid_t group_id)Gets group creation property list

fnherr_t H5Gget_info(hid_t loc_id, H5G_info_t * ginfo)Gets group information

fnherr_t H5Gget_info_by_name(hid_t loc_id, const char * name, H5G_info_t * ginfo, hid_t lapl_id)Gets group information by name

fnherr_t H5Gflush(hid_t group_id)Flushes group to disk

fnherr_t H5Grefresh(hid_t group_id)Refreshes group

fnherr_t H5Gget_num_objs(hid_t loc_id, hsize_t * num_objs)Gets number of objects in group (deprecated)

fnssize_t H5Gget_objname_by_idx(hid_t loc_id, hsize_t idx, char * name, size_t size)Gets object name by index (deprecated)

herr_t H5Gget_info_by_idx(hid_t loc_id,  const  char *  group_name,  int  idx_type,  int  order,
       hsize_t n,  H5G_info_t *  ginfo,  hid_t lapl_id)

Gets group information by index.

fnherr_t H5Giterate(hid_t loc_id, const char * name, int * idx, H5G_iterate_t op, void * op_data)Iterates over objects in a group (deprecated).

fnH5G_obj_t H5Gget_objtype_by_idx(hid_t loc_id, hsize_t idx)Gets object type by index (deprecated).

fnherr_t H5Glink(hid_t loc_id, H5G_link_t type, const char * cur_name, const char * new_name)Creates a link (deprecated).

herr_t H5Glink2(hid_t cur_loc_id,  const  char *  cur_name,  H5G_link_t type,
       hid_t new_loc_id,  const  char *  new_name)

Creates a link with separate source and destination locations (deprecated).

fnherr_t H5Gunlink(hid_t loc_id, const char * name)Removes a link from a group (deprecated).

fnherr_t H5Gmove(hid_t loc_id, const char * src_name, const char * dst_name)Renames a link (deprecated).

fnherr_t H5Gmove2(hid_t src_loc_id, const char * src_name, hid_t dst_loc_id, const char * dst_name)Renames a link with separate source and destination locations (deprecated).

fnint H5Gget_comment(hid_t loc_id, const char * name, size_t bufsize, char * buf)Gets a comment on an object (deprecated).

fnherr_t H5Gset_comment(hid_t loc_id, const char * name, const char * comment)Sets a comment on an object (deprecated).

fnhid_t H5Gcreate1(hid_t loc_id, const char * name, size_t size_hint)Creates a group (version 1, deprecated).

fnhid_t H5Gopen1(hid_t loc_id, const char * name)Opens a group (version 1, deprecated).

fnherr_t H5Gget_linkval(hid_t loc_id, const char * name, size_t size, char * buf)Gets the value of a symbolic link (deprecated).

fnherr_t H5Gget_objinfo(hid_t loc_id, const char * name, hbool_t follow_link, H5G_stat_t * statbuf)Gets object information (deprecated).