H5Pprivate.h File Reference

#include "H5Ppublic.h"
#include "H5private.h"

Go to the source code of this file.

Data Structures
struct	H5P_libclass_t

Macros
#define	H5P_STRCRT_CHAR_ENCODING_NAME   "character_encoding" /* Character set encoding for string */
#define	H5P_PLIST_ID(P)   (H5P_get_plist_id(P))
#define	H5P_CLASS(P)   (H5P_get_class(P))
#define	H5_COLL_MD_READ_FLAG_NAME   "collective_metadata_read"

Typedefs
typedef struct H5P_genplist_t	H5P_genplist_t
typedef enum H5P_coll_md_read_flag_t	H5P_coll_md_read_flag_t
typedef struct H5P_genclass_t	H5P_genclass_t
typedef enum H5P_plist_type_t	H5P_plist_type_t
typedef herr_t(*	H5P_reg_prop_func_t) (H5P_genclass_t *pclass)
typedef struct H5P_libclass_t	H5P_libclass_t

Enumerations
enum	H5P_coll_md_read_flag_t { H5P_FORCE_FALSE = -1, H5P_USER_FALSE = 0, H5P_USER_TRUE = 1 }
enum	H5P_plist_type_t {   H5P_TYPE_USER = 0, H5P_TYPE_ROOT = 1, H5P_TYPE_OBJECT_CREATE = 2, H5P_TYPE_FILE_CREATE = 3,   H5P_TYPE_FILE_ACCESS = 4, H5P_TYPE_DATASET_CREATE = 5, H5P_TYPE_DATASET_ACCESS = 6, H5P_TYPE_DATASET_XFER = 7,   H5P_TYPE_FILE_MOUNT = 8, H5P_TYPE_GROUP_CREATE = 9, H5P_TYPE_GROUP_ACCESS = 10, H5P_TYPE_DATATYPE_CREATE = 11,   H5P_TYPE_DATATYPE_ACCESS = 12, H5P_TYPE_STRING_CREATE = 13, H5P_TYPE_ATTRIBUTE_CREATE = 14, H5P_TYPE_OBJECT_COPY = 15,   H5P_TYPE_LINK_CREATE = 16, H5P_TYPE_LINK_ACCESS = 17, H5P_TYPE_ATTRIBUTE_ACCESS = 18, H5P_TYPE_VOL_INITIALIZE = 19,   H5P_TYPE_MAP_CREATE = 20, H5P_TYPE_MAP_ACCESS = 21, H5P_TYPE_REFERENCE_ACCESS = 22, H5P_TYPE_MAX_TYPE }

Functions
H5_DLL herr_t	H5P_init (void)
H5_DLL herr_t	H5P_close (void *_plist)
H5_DLL hid_t	H5P_create_id (H5P_genclass_t *pclass, hbool_t app_ref)
H5_DLL hid_t	H5P_copy_plist (const H5P_genplist_t *old_plist, hbool_t app_ref)
H5_DLL herr_t	H5P_get (H5P_genplist_t *plist, const char *name, void *value)
H5_DLL herr_t	H5P_set (H5P_genplist_t *plist, const char *name, const void *value)
H5_DLL herr_t	H5P_peek (H5P_genplist_t *plist, const char *name, void *value)
H5_DLL herr_t	H5P_poke (H5P_genplist_t *plist, const char *name, const void *value)
H5_DLL herr_t	H5P_insert (H5P_genplist_t *plist, const char *name, size_t size, void *value, H5P_prp_set_func_t prp_set, H5P_prp_get_func_t prp_get, H5P_prp_encode_func_t prp_encode, H5P_prp_decode_func_t prp_decode, H5P_prp_delete_func_t prp_delete, H5P_prp_copy_func_t prp_copy, H5P_prp_compare_func_t prp_cmp, H5P_prp_close_func_t prp_close)
H5_DLL herr_t	H5P_remove (H5P_genplist_t *plist, const char *name)
H5_DLL htri_t	H5P_exist_plist (const H5P_genplist_t *plist, const char *name)
H5_DLL htri_t	H5P_class_isa (const H5P_genclass_t *pclass1, const H5P_genclass_t *pclass2)
H5_DLL char *	H5P_get_class_name (H5P_genclass_t *pclass)
H5_DLL herr_t	H5P_get_nprops_pclass (const H5P_genclass_t *pclass, size_t *nprops, hbool_t recurse)
H5_DLL hid_t	H5P_peek_driver (H5P_genplist_t *plist)
H5_DLL const void *	H5P_peek_driver_info (H5P_genplist_t *plist)
H5_DLL herr_t	H5P_set_driver (H5P_genplist_t *plist, hid_t new_driver_id, const void *new_driver_info)
H5_DLL herr_t	H5P_set_vol (H5P_genplist_t *plist, hid_t vol_id, const void *vol_info)
H5_DLL herr_t	H5P_reset_vol_class (const H5P_genclass_t *pclass, const struct H5VL_connector_prop_t *vol_prop)
H5_DLL herr_t	H5P_set_vlen_mem_manager (H5P_genplist_t *plist, H5MM_allocate_t alloc_func, void *alloc_info, H5MM_free_t free_func, void *free_info)
H5_DLL herr_t	H5P_is_fill_value_defined (const struct H5O_fill_t *fill, H5D_fill_value_t *status)
H5_DLL int	H5P_fill_value_cmp (const void *value1, const void *value2, size_t size)
H5_DLL herr_t	H5P_modify_filter (H5P_genplist_t *plist, H5Z_filter_t filter, unsigned flags, size_t cd_nelmts, const unsigned cd_values[])
H5_DLL herr_t	H5P_get_filter_by_id (H5P_genplist_t *plist, H5Z_filter_t id, unsigned int *flags, size_t *cd_nelmts, unsigned cd_values[], size_t namelen, char name[], unsigned *filter_config)
H5_DLL htri_t	H5P_filter_in_pline (H5P_genplist_t *plist, H5Z_filter_t id)
H5_DLL hid_t	H5P_get_plist_id (const H5P_genplist_t *plist)
H5_DLL H5P_genclass_t *	H5P_get_class (const H5P_genplist_t *plist)
H5_DLL htri_t	H5P_isa_class (hid_t plist_id, hid_t pclass_id)
H5_DLL H5P_genplist_t *	H5P_object_verify (hid_t plist_id, hid_t pclass_id)
H5_DLL herr_t	H5P_fill_value_defined (H5P_genplist_t *plist, H5D_fill_value_t *status)
H5_DLL herr_t	H5P_get_fill_value (H5P_genplist_t *plist, const struct H5T_t *type, void *value)
H5_DLL int	H5P_ignore_cmp (const void H5_ATTR_UNUSED *val1, const void H5_ATTR_UNUSED *val2, size_t H5_ATTR_UNUSED size)

Variables
H5_DLLVAR H5P_genclass_t *	H5P_CLS_ROOT_g
H5_DLLVAR H5P_genclass_t *	H5P_CLS_OBJECT_CREATE_g
H5_DLLVAR H5P_genclass_t *	H5P_CLS_FILE_CREATE_g
H5_DLLVAR H5P_genclass_t *	H5P_CLS_FILE_ACCESS_g
H5_DLLVAR H5P_genclass_t *	H5P_CLS_DATASET_CREATE_g
H5_DLLVAR H5P_genclass_t *	H5P_CLS_DATASET_ACCESS_g
H5_DLLVAR H5P_genclass_t *	H5P_CLS_DATASET_XFER_g
H5_DLLVAR H5P_genclass_t *	H5P_CLS_FILE_MOUNT_g
H5_DLLVAR H5P_genclass_t *	H5P_CLS_GROUP_CREATE_g
H5_DLLVAR H5P_genclass_t *	H5P_CLS_GROUP_ACCESS_g
H5_DLLVAR H5P_genclass_t *	H5P_CLS_DATATYPE_CREATE_g
H5_DLLVAR H5P_genclass_t *	H5P_CLS_DATATYPE_ACCESS_g
H5_DLLVAR H5P_genclass_t *	H5P_CLS_MAP_CREATE_g
H5_DLLVAR H5P_genclass_t *	H5P_CLS_MAP_ACCESS_g
H5_DLLVAR H5P_genclass_t *	H5P_CLS_ATTRIBUTE_CREATE_g
H5_DLLVAR H5P_genclass_t *	H5P_CLS_ATTRIBUTE_ACCESS_g
H5_DLLVAR H5P_genclass_t *	H5P_CLS_OBJECT_COPY_g
H5_DLLVAR H5P_genclass_t *	H5P_CLS_LINK_CREATE_g
H5_DLLVAR H5P_genclass_t *	H5P_CLS_LINK_ACCESS_g
H5_DLLVAR H5P_genclass_t *	H5P_CLS_STRING_CREATE_g
H5_DLLVAR const struct H5P_libclass_t	H5P_CLS_LCRT [1]
H5_DLLVAR const struct H5P_libclass_t	H5P_CLS_LACC [1]
H5_DLLVAR const struct H5P_libclass_t	H5P_CLS_AACC [1]
H5_DLLVAR const struct H5P_libclass_t	H5P_CLS_DACC [1]
H5_DLLVAR const struct H5P_libclass_t	H5P_CLS_GACC [1]
H5_DLLVAR const struct H5P_libclass_t	H5P_CLS_TACC [1]
H5_DLLVAR const struct H5P_libclass_t	H5P_CLS_MACC [1]
H5_DLLVAR const struct H5P_libclass_t	H5P_CLS_FACC [1]
H5_DLLVAR const struct H5P_libclass_t	H5P_CLS_OCPY [1]

Macro Definition Documentation

H5_COLL_MD_READ_FLAG_NAME

#define H5_COLL_MD_READ_FLAG_NAME   "collective_metadata_read"

H5P_CLASS

#define H5P_CLASS

(

P

)

(H5P_get_class(P))

H5P_PLIST_ID

#define H5P_PLIST_ID

(

P

)

(H5P_get_plist_id(P))

H5P_STRCRT_CHAR_ENCODING_NAME

#define H5P_STRCRT_CHAR_ENCODING_NAME   "character_encoding" /* Character set encoding for string */

Typedef Documentation

H5P_coll_md_read_flag_t

typedef enum H5P_coll_md_read_flag_t H5P_coll_md_read_flag_t

H5P_genclass_t

typedef struct H5P_genclass_t H5P_genclass_t

H5P_genplist_t

typedef struct H5P_genplist_t H5P_genplist_t

H5P_libclass_t

typedef struct H5P_libclass_t H5P_libclass_t

H5P_plist_type_t

typedef enum H5P_plist_type_t H5P_plist_type_t

H5P_reg_prop_func_t

typedef herr_t(* H5P_reg_prop_func_t) (H5P_genclass_t *pclass)

Enumeration Type Documentation

H5P_coll_md_read_flag_t

enum H5P_coll_md_read_flag_t

Enumerator
H5P_FORCE_FALSE
H5P_USER_FALSE
H5P_USER_TRUE

H5P_plist_type_t

enum H5P_plist_type_t

Enumerator
H5P_TYPE_USER
H5P_TYPE_ROOT
H5P_TYPE_OBJECT_CREATE
H5P_TYPE_FILE_CREATE
H5P_TYPE_FILE_ACCESS
H5P_TYPE_DATASET_CREATE
H5P_TYPE_DATASET_ACCESS
H5P_TYPE_DATASET_XFER
H5P_TYPE_FILE_MOUNT
H5P_TYPE_GROUP_CREATE
H5P_TYPE_GROUP_ACCESS
H5P_TYPE_DATATYPE_CREATE
H5P_TYPE_DATATYPE_ACCESS
H5P_TYPE_STRING_CREATE
H5P_TYPE_ATTRIBUTE_CREATE
H5P_TYPE_OBJECT_COPY
H5P_TYPE_LINK_CREATE
H5P_TYPE_LINK_ACCESS
H5P_TYPE_ATTRIBUTE_ACCESS
H5P_TYPE_VOL_INITIALIZE
H5P_TYPE_MAP_CREATE
H5P_TYPE_MAP_ACCESS
H5P_TYPE_REFERENCE_ACCESS
H5P_TYPE_MAX_TYPE

Function Documentation

H5P_class_isa()

H5_DLL htri_t H5P_class_isa	(	const H5P_genclass_t *	pclass1,
		const H5P_genclass_t *	pclass2
	)

H5P_close()

H5_DLL herr_t H5P_close

(

void *

_plist

)

H5P_copy_plist()

H5_DLL hid_t H5P_copy_plist	(	const H5P_genplist_t *	old_plist,
		hbool_t	app_ref
	)

H5P_create_id()

H5_DLL hid_t H5P_create_id	(	H5P_genclass_t *	pclass,
		hbool_t	app_ref
	)

H5P_exist_plist()

H5_DLL htri_t H5P_exist_plist	(	const H5P_genplist_t *	plist,
		const char *	name
	)

H5P_fill_value_cmp()

H5_DLL int H5P_fill_value_cmp	(	const void *	value1,
		const void *	value2,
		size_t	size
	)

H5P_fill_value_defined()

H5_DLL herr_t H5P_fill_value_defined	(	H5P_genplist_t *	plist,
		H5D_fill_value_t *	status
	)

H5P_filter_in_pline()

H5_DLL htri_t H5P_filter_in_pline	(	H5P_genplist_t *	plist,
		H5Z_filter_t	id
	)

H5P_get()

H5_DLL herr_t H5P_get	(	H5P_genplist_t *	plist,
		const char *	name,
		void *	value
	)

H5P_get_class()

H5_DLL H5P_genclass_t* H5P_get_class

(

const H5P_genplist_t *

plist

)

H5P_get_class_name()

H5_DLL char* H5P_get_class_name

(

H5P_genclass_t *

pclass

)

H5P_get_fill_value()

H5_DLL herr_t H5P_get_fill_value	(	H5P_genplist_t *	plist,
		const struct H5T_t *	type,
		void *	value
	)

H5P_get_filter_by_id()

H5_DLL herr_t H5P_get_filter_by_id	(	H5P_genplist_t *	plist,
		H5Z_filter_t	id,
		unsigned int *	flags,
		size_t *	cd_nelmts,
		unsigned	cd_values[],
		size_t	namelen,
		char	name[],
		unsigned *	filter_config
	)

H5P_get_nprops_pclass()

H5_DLL herr_t H5P_get_nprops_pclass	(	const H5P_genclass_t *	pclass,
		size_t *	nprops,
		hbool_t	recurse
	)

H5P_get_plist_id()

H5_DLL hid_t H5P_get_plist_id

(

const H5P_genplist_t *

plist

)

H5P_ignore_cmp()

H5_DLL int H5P_ignore_cmp	(	const void H5_ATTR_UNUSED *	val1,
		const void H5_ATTR_UNUSED *	val2,
		size_t H5_ATTR_UNUSED	size
	)

H5P_init()

H5_DLL herr_t H5P_init

(

void

)

H5P_insert()

H5_DLL herr_t H5P_insert	(	H5P_genplist_t *	plist,
		const char *	name,
		size_t	size,
		void *	value,
		H5P_prp_set_func_t	prp_set,
		H5P_prp_get_func_t	prp_get,
		H5P_prp_encode_func_t	prp_encode,
		H5P_prp_decode_func_t	prp_decode,
		H5P_prp_delete_func_t	prp_delete,
		H5P_prp_copy_func_t	prp_copy,
		H5P_prp_compare_func_t	prp_cmp,
		H5P_prp_close_func_t	prp_close
	)

H5P_is_fill_value_defined()

H5_DLL herr_t H5P_is_fill_value_defined	(	const struct H5O_fill_t *	fill,
		H5D_fill_value_t *	status
	)

H5P_isa_class()

H5_DLL htri_t H5P_isa_class	(	hid_t	plist_id,
		hid_t	pclass_id
	)

H5P_modify_filter()

H5_DLL herr_t H5P_modify_filter	(	H5P_genplist_t *	plist,
		H5Z_filter_t	filter,
		unsigned	flags,
		size_t	cd_nelmts,
		const unsigned	cd_values[]
	)

H5P_object_verify()

H5_DLL H5P_genplist_t* H5P_object_verify	(	hid_t	plist_id,
		hid_t	pclass_id
	)

H5P_peek()

H5_DLL herr_t H5P_peek	(	H5P_genplist_t *	plist,
		const char *	name,
		void *	value
	)

H5P_peek_driver()

H5_DLL hid_t H5P_peek_driver

(

H5P_genplist_t *

plist

)

H5P_peek_driver_info()

H5_DLL const void* H5P_peek_driver_info

(

H5P_genplist_t *

plist

)

H5P_poke()

H5_DLL herr_t H5P_poke	(	H5P_genplist_t *	plist,
		const char *	name,
		const void *	value
	)

H5P_remove()

H5_DLL herr_t H5P_remove	(	H5P_genplist_t *	plist,
		const char *	name
	)

H5P_reset_vol_class()

H5_DLL herr_t H5P_reset_vol_class	(	const H5P_genclass_t *	pclass,
		const struct H5VL_connector_prop_t *	vol_prop
	)

H5P_set()

H5_DLL herr_t H5P_set	(	H5P_genplist_t *	plist,
		const char *	name,
		const void *	value
	)

H5P_set_driver()

H5_DLL herr_t H5P_set_driver	(	H5P_genplist_t *	plist,
		hid_t	new_driver_id,
		const void *	new_driver_info
	)

H5P_set_vlen_mem_manager()

H5_DLL herr_t H5P_set_vlen_mem_manager	(	H5P_genplist_t *	plist,
		H5MM_allocate_t	alloc_func,
		void *	alloc_info,
		H5MM_free_t	free_func,
		void *	free_info
	)

H5P_set_vol()

H5_DLL herr_t H5P_set_vol	(	H5P_genplist_t *	plist,
		hid_t	vol_id,
		const void *	vol_info
	)

Variable Documentation

H5P_CLS_AACC

H5_DLLVAR const struct H5P_libclass_t H5P_CLS_AACC[1]

H5P_CLS_ATTRIBUTE_ACCESS_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_ATTRIBUTE_ACCESS_g

H5P_CLS_ATTRIBUTE_CREATE_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_ATTRIBUTE_CREATE_g

H5P_CLS_DACC

H5_DLLVAR const struct H5P_libclass_t H5P_CLS_DACC[1]

H5P_CLS_DATASET_ACCESS_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_DATASET_ACCESS_g

H5P_CLS_DATASET_CREATE_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_DATASET_CREATE_g

H5P_CLS_DATASET_XFER_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_DATASET_XFER_g

H5P_CLS_DATATYPE_ACCESS_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_DATATYPE_ACCESS_g

H5P_CLS_DATATYPE_CREATE_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_DATATYPE_CREATE_g

H5P_CLS_FACC

H5_DLLVAR const struct H5P_libclass_t H5P_CLS_FACC[1]

H5P_CLS_FILE_ACCESS_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_FILE_ACCESS_g

H5P_CLS_FILE_CREATE_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_FILE_CREATE_g

H5P_CLS_FILE_MOUNT_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_FILE_MOUNT_g

H5P_CLS_GACC

H5_DLLVAR const struct H5P_libclass_t H5P_CLS_GACC[1]

H5P_CLS_GROUP_ACCESS_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_GROUP_ACCESS_g

H5P_CLS_GROUP_CREATE_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_GROUP_CREATE_g

H5P_CLS_LACC

H5_DLLVAR const struct H5P_libclass_t H5P_CLS_LACC[1]

H5P_CLS_LCRT

H5_DLLVAR const struct H5P_libclass_t H5P_CLS_LCRT[1]

H5P_CLS_LINK_ACCESS_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_LINK_ACCESS_g

H5P_CLS_LINK_CREATE_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_LINK_CREATE_g

H5P_CLS_MACC

H5_DLLVAR const struct H5P_libclass_t H5P_CLS_MACC[1]

H5P_CLS_MAP_ACCESS_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_MAP_ACCESS_g

H5P_CLS_MAP_CREATE_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_MAP_CREATE_g

H5P_CLS_OBJECT_COPY_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_OBJECT_COPY_g

H5P_CLS_OBJECT_CREATE_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_OBJECT_CREATE_g

H5P_CLS_OCPY

H5_DLLVAR const struct H5P_libclass_t H5P_CLS_OCPY[1]

H5P_CLS_ROOT_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_ROOT_g

H5P_CLS_STRING_CREATE_g

H5_DLLVAR H5P_genclass_t* H5P_CLS_STRING_CREATE_g

H5P_CLS_TACC

H5_DLLVAR const struct H5P_libclass_t H5P_CLS_TACC[1]