H5Gpublic.h File Reference

#include <sys/types.h>
#include "H5public.h"
#include "H5Lpublic.h"
#include "H5Opublic.h"
#include "H5Tpublic.h"

Go to the source code of this file.

Data Structures
struct	H5G_info_t
struct	H5G_stat_t

Macros
#define	H5G_SAME_LOC   H5L_SAME_LOC
#define	H5G_LINK_ERROR   H5L_TYPE_ERROR
#define	H5G_LINK_HARD   H5L_TYPE_HARD
#define	H5G_LINK_SOFT   H5L_TYPE_SOFT
#define	H5G_link_t   H5L_type_t
#define	H5G_NTYPES   256 /* Max possible number of types */
#define	H5G_NLIBTYPES   8 /* Number of internal types */
#define	H5G_NUSERTYPES   (H5G_NTYPES - H5G_NLIBTYPES)
#define	H5G_USERTYPE(X)   (8 + (X)) /* User defined types */

Typedefs
typedef enum H5G_storage_type_t	H5G_storage_type_t
typedef struct H5G_info_t	H5G_info_t
typedef enum H5G_obj_t	H5G_obj_t
typedef herr_t(*	H5G_iterate_t) (hid_t group, const char *name, void *op_data)
typedef struct H5G_stat_t	H5G_stat_t

Enumerations
enum	H5G_storage_type_t {   H5G_STORAGE_TYPE_UNKNOWN = -1,   H5G_STORAGE_TYPE_SYMBOL_TABLE,   H5G_STORAGE_TYPE_COMPACT,   H5G_STORAGE_TYPE_DENSE }
enum	H5G_obj_t {   H5G_UNKNOWN = -1,   H5G_GROUP,   H5G_DATASET,   H5G_TYPE,   H5G_LINK,   H5G_UDLINK,   H5G_RESERVED_5,   H5G_RESERVED_6,   H5G_RESERVED_7 }

Functions
H5_DLL hid_t	H5Gcreate2 (hid_t loc_id, const char *name, hid_t lcpl_id, hid_t gcpl_id, hid_t gapl_id)
H5_DLL hid_t	H5Gcreate_anon (hid_t loc_id, hid_t gcpl_id, hid_t gapl_id)
H5_DLL hid_t	H5Gopen2 (hid_t loc_id, const char *name, hid_t gapl_id)
H5_DLL hid_t	H5Gget_create_plist (hid_t group_id)
H5_DLL herr_t	H5Gget_info (hid_t loc_id, H5G_info_t *ginfo)
H5_DLL herr_t	H5Gget_info_by_name (hid_t loc_id, const char *name, H5G_info_t *ginfo, hid_t lapl_id)
H5_DLL herr_t	H5Gget_info_by_idx (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, H5G_info_t *ginfo, hid_t lapl_id)
H5_DLL herr_t	H5Gclose (hid_t group_id)
H5_DLL hid_t	H5Gcreate1 (hid_t loc_id, const char *name, size_t size_hint)
H5_DLL hid_t	H5Gopen1 (hid_t loc_id, const char *name)
H5_DLL herr_t	H5Glink (hid_t cur_loc_id, H5G_link_t type, const char *cur_name, const char *new_name)
H5_DLL 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)
H5_DLL herr_t	H5Gmove (hid_t src_loc_id, const char *src_name, const char *dst_name)
H5_DLL herr_t	H5Gmove2 (hid_t src_loc_id, const char *src_name, hid_t dst_loc_id, const char *dst_name)
H5_DLL herr_t	H5Gunlink (hid_t loc_id, const char *name)
H5_DLL herr_t	H5Gget_linkval (hid_t loc_id, const char *name, size_t size, char *buf)
H5_DLL herr_t	H5Gset_comment (hid_t loc_id, const char *name, const char *comment)
H5_DLL int	H5Gget_comment (hid_t loc_id, const char *name, size_t bufsize, char *buf)
H5_DLL herr_t	H5Giterate (hid_t loc_id, const char *name, int *idx, H5G_iterate_t op, void *op_data)
H5_DLL herr_t	H5Gget_num_objs (hid_t loc_id, hsize_t *num_objs)
H5_DLL herr_t	H5Gget_objinfo (hid_t loc_id, const char *name, hbool_t follow_link, H5G_stat_t *statbuf)
H5_DLL ssize_t	H5Gget_objname_by_idx (hid_t loc_id, hsize_t idx, char *name, size_t size)
H5_DLL H5G_obj_t	H5Gget_objtype_by_idx (hid_t loc_id, hsize_t idx)

Macro Definition Documentation

H5G_LINK_ERROR

#define H5G_LINK_ERROR   H5L_TYPE_ERROR

Definition at line 96 of file H5Gpublic.h.

H5G_LINK_HARD

#define H5G_LINK_HARD   H5L_TYPE_HARD

Definition at line 97 of file H5Gpublic.h.

H5G_LINK_SOFT

#define H5G_LINK_SOFT   H5L_TYPE_SOFT

Definition at line 98 of file H5Gpublic.h.

H5G_link_t

#define H5G_link_t   H5L_type_t

Definition at line 99 of file H5Gpublic.h.

H5G_NLIBTYPES

#define H5G_NLIBTYPES   8 /* Number of internal types */

Definition at line 103 of file H5Gpublic.h.

H5G_NTYPES

#define H5G_NTYPES   256 /* Max possible number of types */

Definition at line 102 of file H5Gpublic.h.

H5G_NUSERTYPES

#define H5G_NUSERTYPES   (H5G_NTYPES - H5G_NLIBTYPES)

Definition at line 104 of file H5Gpublic.h.

H5G_SAME_LOC

#define H5G_SAME_LOC   H5L_SAME_LOC

Definition at line 95 of file H5Gpublic.h.

H5G_USERTYPE

#define H5G_USERTYPE

(

X

)

(8 + (X)) /* User defined types */

Definition at line 105 of file H5Gpublic.h.

Typedef Documentation

H5G_info_t

typedef struct H5G_info_t H5G_info_t

H5G_iterate_t

typedef herr_t(* H5G_iterate_t) (hid_t group, const char *name, void *op_data)

Definition at line 130 of file H5Gpublic.h.

H5G_obj_t

typedef enum H5G_obj_t H5G_obj_t

H5G_stat_t

typedef struct H5G_stat_t H5G_stat_t

H5G_storage_type_t

typedef enum H5G_storage_type_t H5G_storage_type_t

Enumeration Type Documentation

H5G_obj_t

enum H5G_obj_t

Enumerator
H5G_UNKNOWN
H5G_GROUP
H5G_DATASET
H5G_TYPE
H5G_LINK
H5G_UDLINK
H5G_RESERVED_5
H5G_RESERVED_6
H5G_RESERVED_7

Definition at line 117 of file H5Gpublic.h.

H5G_storage_type_t

enum H5G_storage_type_t

Enumerator
H5G_STORAGE_TYPE_UNKNOWN
H5G_STORAGE_TYPE_SYMBOL_TABLE
H5G_STORAGE_TYPE_COMPACT
H5G_STORAGE_TYPE_DENSE

Definition at line 49 of file H5Gpublic.h.

Function Documentation

H5Gclose()

H5_DLL herr_t H5Gclose

(

hid_t

group_id

)

H5Gcreate1()

H5_DLL hid_t H5Gcreate1	(	hid_t	loc_id,
		const char *	name,
		size_t	size_hint
	)

H5Gcreate2()

H5_DLL hid_t H5Gcreate2	(	hid_t	loc_id,
		const char *	name,
		hid_t	lcpl_id,
		hid_t	gcpl_id,
		hid_t	gapl_id
	)

H5Gcreate_anon()

H5_DLL hid_t H5Gcreate_anon	(	hid_t	loc_id,
		hid_t	gcpl_id,
		hid_t	gapl_id
	)

H5Gget_comment()

H5_DLL int H5Gget_comment	(	hid_t	loc_id,
		const char *	name,
		size_t	bufsize,
		char *	buf
	)

H5Gget_create_plist()

H5_DLL hid_t H5Gget_create_plist

(

hid_t

group_id

)

H5Gget_info()

H5_DLL herr_t H5Gget_info	(	hid_t	loc_id,
		H5G_info_t *	ginfo
	)

H5Gget_info_by_idx()

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

H5Gget_info_by_name()

H5_DLL herr_t H5Gget_info_by_name	(	hid_t	loc_id,
		const char *	name,
		H5G_info_t *	ginfo,
		hid_t	lapl_id
	)

H5Gget_linkval()

H5_DLL herr_t H5Gget_linkval	(	hid_t	loc_id,
		const char *	name,
		size_t	size,
		char *	buf
	)

H5Gget_num_objs()

H5_DLL herr_t H5Gget_num_objs	(	hid_t	loc_id,
		hsize_t *	num_objs
	)

H5Gget_objinfo()

H5_DLL herr_t H5Gget_objinfo	(	hid_t	loc_id,
		const char *	name,
		hbool_t	follow_link,
		H5G_stat_t *	statbuf
	)

H5Gget_objname_by_idx()

H5_DLL ssize_t H5Gget_objname_by_idx	(	hid_t	loc_id,
		hsize_t	idx,
		char *	name,
		size_t	size
	)

H5Gget_objtype_by_idx()

H5_DLL H5G_obj_t H5Gget_objtype_by_idx	(	hid_t	loc_id,
		hsize_t	idx
	)

H5Giterate()

H5_DLL herr_t H5Giterate	(	hid_t	loc_id,
		const char *	name,
		int *	idx,
		H5G_iterate_t	op,
		void *	op_data
	)

H5Glink()

H5_DLL herr_t H5Glink	(	hid_t	cur_loc_id,
		H5G_link_t	type,
		const char *	cur_name,
		const char *	new_name
	)

H5Glink2()

H5_DLL 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
	)

H5Gmove()

H5_DLL herr_t H5Gmove	(	hid_t	src_loc_id,
		const char *	src_name,
		const char *	dst_name
	)

H5Gmove2()

H5_DLL herr_t H5Gmove2	(	hid_t	src_loc_id,
		const char *	src_name,
		hid_t	dst_loc_id,
		const char *	dst_name
	)

H5Gopen1()

H5_DLL hid_t H5Gopen1	(	hid_t	loc_id,
		const char *	name
	)

H5Gopen2()

H5_DLL hid_t H5Gopen2	(	hid_t	loc_id,
		const char *	name,
		hid_t	gapl_id
	)

H5Gset_comment()

H5_DLL herr_t H5Gset_comment	(	hid_t	loc_id,
		const char *	name,
		const char *	comment
	)

H5Gunlink()

H5_DLL herr_t H5Gunlink	(	hid_t	loc_id,
		const char *	name
	)