#include "H5public.h"
#include "H5Ipublic.h"
#include "H5Lpublic.h"

Data Structures
struct	H5O_hdr_info_t

struct	H5O_info_t

struct	H5O_stat_t

Macros
#define	H5O_COPY_SHALLOW_HIERARCHY_FLAG (0x0001u) /* Copy only immediate members */

#define	H5O_COPY_EXPAND_SOFT_LINK_FLAG (0x0002u) /* Expand soft links into new objects */

#define	H5O_COPY_EXPAND_EXT_LINK_FLAG (0x0004u) /* Expand external links into new objects */

#define	H5O_COPY_EXPAND_REFERENCE_FLAG (0x0008u) /* Copy objects that are pointed by references */

#define	H5O_COPY_WITHOUT_ATTR_FLAG (0x0010u) /* Copy object without copying attributes */

#define	H5O_COPY_PRESERVE_NULL_FLAG (0x0020u) /* Copy NULL messages (empty space) */

#define	H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG (0x0040u) /* Merge committed datatypes in dest file */

#define	H5O_COPY_ALL (0x007Fu) /* All object copying flags (for internal checking) */

#define	H5O_SHMESG_NONE_FLAG 0x0000 /* No shared messages */

#define	H5O_SHMESG_SDSPACE_FLAG ((unsigned)1 << 0x0001) /* Simple Dataspace Message. */

#define	H5O_SHMESG_DTYPE_FLAG ((unsigned)1 << 0x0003) /* Datatype Message. */

#define	H5O_SHMESG_FILL_FLAG ((unsigned)1 << 0x0005) /* Fill Value Message. */

#define	H5O_SHMESG_PLINE_FLAG ((unsigned)1 << 0x000b) /* Filter pipeline message. */

#define	H5O_SHMESG_ATTR_FLAG ((unsigned)1 << 0x000c) /* Attribute Message. */

#define	H5O_SHMESG_ALL_FLAG (H5O_SHMESG_SDSPACE_FLAG \| H5O_SHMESG_DTYPE_FLAG \| H5O_SHMESG_FILL_FLAG \| H5O_SHMESG_PLINE_FLAG \| H5O_SHMESG_ATTR_FLAG)

#define	H5O_HDR_CHUNK0_SIZE 0x03 /* 2-bit field indicating # of bytes to store the size of chunk 0's data */

#define	H5O_HDR_ATTR_CRT_ORDER_TRACKED 0x04 /* Attribute creation order is tracked */

#define	H5O_HDR_ATTR_CRT_ORDER_INDEXED 0x08 /* Attribute creation order has index */

#define	H5O_HDR_ATTR_STORE_PHASE_CHANGE 0x10 /* Non-default attribute storage phase change values stored */

#define	H5O_HDR_STORE_TIMES 0x20 /* Store access, modification, change & birth times for object */

#define	H5O_HDR_ALL_FLAGS (H5O_HDR_CHUNK0_SIZE \| H5O_HDR_ATTR_CRT_ORDER_TRACKED \| H5O_HDR_ATTR_CRT_ORDER_INDEXED \| H5O_HDR_ATTR_STORE_PHASE_CHANGE \| H5O_HDR_STORE_TIMES)

#define	H5O_SHMESG_MAX_NINDEXES 8

#define	H5O_SHMESG_MAX_LIST_SIZE 5000

Typedefs
typedef enum H5O_type_t	H5O_type_t

typedef struct H5O_hdr_info_t	H5O_hdr_info_t

typedef struct H5O_info_t	H5O_info_t

typedef uint32_t	H5O_msg_crt_idx_t

typedef herr_t(*	H5O_iterate_t) (hid_t obj, const char name, const H5O_info_t info, void *op_data)

typedef enum H5O_mcdt_search_ret_t	H5O_mcdt_search_ret_t

typedef H5O_mcdt_search_ret_t(*	H5O_mcdt_search_cb_t) (void *op_data)

typedef struct H5O_stat_t	H5O_stat_t

Enumerations
enum	H5O_type_t { H5O_TYPE_UNKNOWN = -1, H5O_TYPE_GROUP, H5O_TYPE_DATASET, H5O_TYPE_NAMED_DATATYPE, H5O_TYPE_NTYPES }

enum	H5O_mcdt_search_ret_t { H5O_MCDT_SEARCH_ERROR = -1, H5O_MCDT_SEARCH_CONT, H5O_MCDT_SEARCH_STOP }

Functions
H5_DLL hid_t	H5Oopen (hid_t loc_id, const char *name, hid_t lapl_id)

H5_DLL hid_t	H5Oopen_by_addr (hid_t loc_id, haddr_t addr)

H5_DLL hid_t	H5Oopen_by_idx (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, hid_t lapl_id)

H5_DLL htri_t	H5Oexists_by_name (hid_t loc_id, const char *name, hid_t lapl_id)

H5_DLL herr_t	H5Oget_info (hid_t loc_id, H5O_info_t *oinfo)

H5_DLL herr_t	H5Oget_info_by_name (hid_t loc_id, const char name, H5O_info_t oinfo, hid_t lapl_id)

H5_DLL herr_t	H5Oget_info_by_idx (hid_t loc_id, const char group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, H5O_info_t oinfo, hid_t lapl_id)

H5_DLL herr_t	H5Olink (hid_t obj_id, hid_t new_loc_id, const char *new_name, hid_t lcpl_id, hid_t lapl_id)

H5_DLL herr_t	H5Oincr_refcount (hid_t object_id)

H5_DLL herr_t	H5Odecr_refcount (hid_t object_id)

H5_DLL herr_t	H5Ocopy (hid_t src_loc_id, const char src_name, hid_t dst_loc_id, const char dst_name, hid_t ocpypl_id, hid_t lcpl_id)

H5_DLL herr_t	H5Oset_comment (hid_t obj_id, const char *comment)

H5_DLL herr_t	H5Oset_comment_by_name (hid_t loc_id, const char name, const char comment, hid_t lapl_id)

H5_DLL ssize_t	H5Oget_comment (hid_t obj_id, char *comment, size_t bufsize)

H5_DLL ssize_t	H5Oget_comment_by_name (hid_t loc_id, const char name, char comment, size_t bufsize, hid_t lapl_id)

H5_DLL herr_t	H5Ovisit (hid_t obj_id, H5_index_t idx_type, H5_iter_order_t order, H5O_iterate_t op, void *op_data)

H5_DLL herr_t	H5Ovisit_by_name (hid_t loc_id, const char obj_name, H5_index_t idx_type, H5_iter_order_t order, H5O_iterate_t op, void op_data, hid_t lapl_id)

H5_DLL herr_t	H5Oclose (hid_t object_id)

Macro Definition Documentation

◆ H5O_COPY_ALL

#define H5O_COPY_ALL (0x007Fu) /* All object copying flags (for internal checking) */

Definition at line 45 of file H5Opublic.h.

◆ H5O_COPY_EXPAND_EXT_LINK_FLAG

#define H5O_COPY_EXPAND_EXT_LINK_FLAG (0x0004u) /* Expand external links into new objects */

Definition at line 40 of file H5Opublic.h.

◆ H5O_COPY_EXPAND_REFERENCE_FLAG

#define H5O_COPY_EXPAND_REFERENCE_FLAG (0x0008u) /* Copy objects that are pointed by references */

Definition at line 41 of file H5Opublic.h.

◆ H5O_COPY_EXPAND_SOFT_LINK_FLAG

#define H5O_COPY_EXPAND_SOFT_LINK_FLAG (0x0002u) /* Expand soft links into new objects */

Definition at line 39 of file H5Opublic.h.

◆ H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG

#define H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG (0x0040u) /* Merge committed datatypes in dest file */

Definition at line 44 of file H5Opublic.h.

◆ H5O_COPY_PRESERVE_NULL_FLAG

#define H5O_COPY_PRESERVE_NULL_FLAG (0x0020u) /* Copy NULL messages (empty space) */

Definition at line 43 of file H5Opublic.h.

◆ H5O_COPY_SHALLOW_HIERARCHY_FLAG

#define H5O_COPY_SHALLOW_HIERARCHY_FLAG (0x0001u) /* Copy only immediate members */

Definition at line 38 of file H5Opublic.h.

◆ H5O_COPY_WITHOUT_ATTR_FLAG

#define H5O_COPY_WITHOUT_ATTR_FLAG (0x0010u) /* Copy object without copying attributes */

Definition at line 42 of file H5Opublic.h.

◆ H5O_HDR_ALL_FLAGS

#define H5O_HDR_ALL_FLAGS (H5O_HDR_CHUNK0_SIZE | H5O_HDR_ATTR_CRT_ORDER_TRACKED | H5O_HDR_ATTR_CRT_ORDER_INDEXED | H5O_HDR_ATTR_STORE_PHASE_CHANGE | H5O_HDR_STORE_TIMES)

Definition at line 68 of file H5Opublic.h.

◆ H5O_HDR_ATTR_CRT_ORDER_INDEXED

#define H5O_HDR_ATTR_CRT_ORDER_INDEXED 0x08 /* Attribute creation order has index */

Definition at line 65 of file H5Opublic.h.

◆ H5O_HDR_ATTR_CRT_ORDER_TRACKED

#define H5O_HDR_ATTR_CRT_ORDER_TRACKED 0x04 /* Attribute creation order is tracked */

Definition at line 64 of file H5Opublic.h.

◆ H5O_HDR_ATTR_STORE_PHASE_CHANGE

#define H5O_HDR_ATTR_STORE_PHASE_CHANGE 0x10 /* Non-default attribute storage phase change values stored */

Definition at line 66 of file H5Opublic.h.

◆ H5O_HDR_CHUNK0_SIZE

#define H5O_HDR_CHUNK0_SIZE 0x03 /* 2-bit field indicating # of bytes to store the size of chunk 0's data */

Definition at line 63 of file H5Opublic.h.

◆ H5O_HDR_STORE_TIMES

#define H5O_HDR_STORE_TIMES 0x20 /* Store access, modification, change & birth times for object */

Definition at line 67 of file H5Opublic.h.

◆ H5O_SHMESG_ALL_FLAG

#define H5O_SHMESG_ALL_FLAG (H5O_SHMESG_SDSPACE_FLAG | H5O_SHMESG_DTYPE_FLAG | H5O_SHMESG_FILL_FLAG | H5O_SHMESG_PLINE_FLAG | H5O_SHMESG_ATTR_FLAG)

Definition at line 60 of file H5Opublic.h.

◆ H5O_SHMESG_ATTR_FLAG

#define H5O_SHMESG_ATTR_FLAG ((unsigned)1 << 0x000c) /* Attribute Message. */

Definition at line 59 of file H5Opublic.h.

◆ H5O_SHMESG_DTYPE_FLAG

#define H5O_SHMESG_DTYPE_FLAG ((unsigned)1 << 0x0003) /* Datatype Message. */

Definition at line 56 of file H5Opublic.h.

◆ H5O_SHMESG_FILL_FLAG

#define H5O_SHMESG_FILL_FLAG ((unsigned)1 << 0x0005) /* Fill Value Message. */

Definition at line 57 of file H5Opublic.h.

◆ H5O_SHMESG_MAX_LIST_SIZE

#define H5O_SHMESG_MAX_LIST_SIZE 5000

Definition at line 74 of file H5Opublic.h.

◆ H5O_SHMESG_MAX_NINDEXES

#define H5O_SHMESG_MAX_NINDEXES 8

Definition at line 73 of file H5Opublic.h.

◆ H5O_SHMESG_NONE_FLAG

#define H5O_SHMESG_NONE_FLAG 0x0000 /* No shared messages */

Definition at line 54 of file H5Opublic.h.

◆ H5O_SHMESG_PLINE_FLAG

#define H5O_SHMESG_PLINE_FLAG ((unsigned)1 << 0x000b) /* Filter pipeline message. */

Definition at line 58 of file H5Opublic.h.

◆ H5O_SHMESG_SDSPACE_FLAG

#define H5O_SHMESG_SDSPACE_FLAG ((unsigned)1 << 0x0001) /* Simple Dataspace Message. */

Definition at line 55 of file H5Opublic.h.

Typedef Documentation

◆ H5O_hdr_info_t

typedef struct H5O_hdr_info_t H5O_hdr_info_t

◆ H5O_info_t

typedef struct H5O_info_t H5O_info_t

◆ H5O_iterate_t

typedef herr_t(* H5O_iterate_t) (hid_t obj, const char *name, const H5O_info_t *info, void *op_data)

Definition at line 130 of file H5Opublic.h.

◆ H5O_mcdt_search_cb_t

typedef H5O_mcdt_search_ret_t(* H5O_mcdt_search_cb_t) (void *op_data)

Definition at line 140 of file H5Opublic.h.

◆ H5O_mcdt_search_ret_t

typedef enum H5O_mcdt_search_ret_t H5O_mcdt_search_ret_t

◆ H5O_msg_crt_idx_t

typedef uint32_t H5O_msg_crt_idx_t

Definition at line 127 of file H5Opublic.h.

◆ H5O_stat_t

typedef struct H5O_stat_t H5O_stat_t

◆ H5O_type_t

typedef enum H5O_type_t H5O_type_t

Enumeration Type Documentation

◆ H5O_mcdt_search_ret_t

enum H5O_mcdt_search_ret_t

Enumerator
H5O_MCDT_SEARCH_ERROR
H5O_MCDT_SEARCH_CONT
H5O_MCDT_SEARCH_STOP

Definition at line 133 of file H5Opublic.h.

◆ H5O_type_t

enum H5O_type_t

Enumerator
H5O_TYPE_UNKNOWN
H5O_TYPE_GROUP
H5O_TYPE_DATASET
H5O_TYPE_NAMED_DATATYPE
H5O_TYPE_NTYPES

Definition at line 81 of file H5Opublic.h.

Function Documentation

◆ H5Oclose()

H5_DLL herr_t H5Oclose ( hid_t object_id )

◆ H5Ocopy()

H5_DLL herr_t H5Ocopy	(	hid_t	src_loc_id,
		const char *	src_name,
		hid_t	dst_loc_id,
		const char *	dst_name,
		hid_t	ocpypl_id,
		hid_t	lcpl_id
	)

◆ H5Odecr_refcount()

H5_DLL herr_t H5Odecr_refcount ( hid_t object_id )

◆ H5Oexists_by_name()

H5_DLL htri_t H5Oexists_by_name	(	hid_t	loc_id,
		const char *	name,
		hid_t	lapl_id
	)

◆ H5Oget_comment()

H5_DLL ssize_t H5Oget_comment	(	hid_t	obj_id,
		char *	comment,
		size_t	bufsize
	)

◆ H5Oget_comment_by_name()

H5_DLL ssize_t H5Oget_comment_by_name	(	hid_t	loc_id,
		const char *	name,
		char *	comment,
		size_t	bufsize,
		hid_t	lapl_id
	)

◆ H5Oget_info()

H5_DLL herr_t H5Oget_info	(	hid_t	loc_id,
		H5O_info_t *	oinfo
	)

◆ H5Oget_info_by_idx()

H5_DLL herr_t H5Oget_info_by_idx	(	hid_t	loc_id,
		const char *	group_name,
		H5_index_t	idx_type,
		H5_iter_order_t	order,
		hsize_t	n,
		H5O_info_t *	oinfo,
		hid_t	lapl_id
	)

◆ H5Oget_info_by_name()

H5_DLL herr_t H5Oget_info_by_name	(	hid_t	loc_id,
		const char *	name,
		H5O_info_t *	oinfo,
		hid_t	lapl_id
	)

◆ H5Oincr_refcount()

H5_DLL herr_t H5Oincr_refcount ( hid_t object_id )

◆ H5Olink()

H5_DLL herr_t H5Olink	(	hid_t	obj_id,
		hid_t	new_loc_id,
		const char *	new_name,
		hid_t	lcpl_id,
		hid_t	lapl_id
	)

◆ H5Oopen()

H5_DLL hid_t H5Oopen	(	hid_t	loc_id,
		const char *	name,
		hid_t	lapl_id
	)

◆ H5Oopen_by_addr()

H5_DLL hid_t H5Oopen_by_addr	(	hid_t	loc_id,
		haddr_t	addr
	)

◆ H5Oopen_by_idx()

H5_DLL hid_t H5Oopen_by_idx	(	hid_t	loc_id,
		const char *	group_name,
		H5_index_t	idx_type,
		H5_iter_order_t	order,
		hsize_t	n,
		hid_t	lapl_id
	)

◆ H5Oset_comment()

H5_DLL herr_t H5Oset_comment	(	hid_t	obj_id,
		const char *	comment
	)

◆ H5Oset_comment_by_name()

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

◆ H5Ovisit()

H5_DLL herr_t H5Ovisit	(	hid_t	obj_id,
		H5_index_t	idx_type,
		H5_iter_order_t	order,
		H5O_iterate_t	op,
		void *	op_data
	)

◆ H5Ovisit_by_name()

H5_DLL herr_t H5Ovisit_by_name	(	hid_t	loc_id,
		const char *	obj_name,
		H5_index_t	idx_type,
		H5_iter_order_t	order,
		H5O_iterate_t	op,
		void *	op_data,
		hid_t	lapl_id
	)

Data Structures

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

◆ H5O_COPY_ALL

◆ H5O_COPY_EXPAND_EXT_LINK_FLAG

◆ H5O_COPY_EXPAND_REFERENCE_FLAG

◆ H5O_COPY_EXPAND_SOFT_LINK_FLAG

◆ H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG

◆ H5O_COPY_PRESERVE_NULL_FLAG

◆ H5O_COPY_SHALLOW_HIERARCHY_FLAG

◆ H5O_COPY_WITHOUT_ATTR_FLAG

◆ H5O_HDR_ALL_FLAGS

◆ H5O_HDR_ATTR_CRT_ORDER_INDEXED

◆ H5O_HDR_ATTR_CRT_ORDER_TRACKED

◆ H5O_HDR_ATTR_STORE_PHASE_CHANGE

◆ H5O_HDR_CHUNK0_SIZE

◆ H5O_HDR_STORE_TIMES

◆ H5O_SHMESG_ALL_FLAG

◆ H5O_SHMESG_ATTR_FLAG

◆ H5O_SHMESG_DTYPE_FLAG

◆ H5O_SHMESG_FILL_FLAG

◆ H5O_SHMESG_MAX_LIST_SIZE

◆ H5O_SHMESG_MAX_NINDEXES

◆ H5O_SHMESG_NONE_FLAG

◆ H5O_SHMESG_PLINE_FLAG

◆ H5O_SHMESG_SDSPACE_FLAG

Typedef Documentation

◆ H5O_hdr_info_t

◆ H5O_info_t

◆ H5O_iterate_t

◆ H5O_mcdt_search_cb_t

◆ H5O_mcdt_search_ret_t

◆ H5O_msg_crt_idx_t

◆ H5O_stat_t

◆ H5O_type_t

Enumeration Type Documentation

◆ H5O_mcdt_search_ret_t

◆ H5O_type_t

Function Documentation

◆ H5Oclose()

◆ H5Ocopy()

◆ H5Odecr_refcount()

◆ H5Oexists_by_name()

◆ H5Oget_comment()

◆ H5Oget_comment_by_name()

◆ H5Oget_info()

◆ H5Oget_info_by_idx()

◆ H5Oget_info_by_name()

◆ H5Oincr_refcount()

◆ H5Olink()

◆ H5Oopen()

◆ H5Oopen_by_addr()

◆ H5Oopen_by_idx()

◆ H5Oset_comment()

◆ H5Oset_comment_by_name()

◆ H5Ovisit()

◆ H5Ovisit_by_name()