Class H5P

Inheritance

System.Object

H5P

Namespace: HDF.PInvoke

Assembly: HDF.PInvoke.dll

Syntax

public sealed class H5P : object

Fields

CRT_ORDER_INDEXED

Declaration

public const uint CRT_ORDER_INDEXED = null

Field Value

Type	Description
System.UInt32

CRT_ORDER_TRACKED

Declaration

public const uint CRT_ORDER_TRACKED = null

Field Value

Type	Description
System.UInt32

DEFAULT

Default value for all property list classes

Declaration

public const System.Int64 DEFAULT = null

Field Value

Type	Description
System.Int64

Properties

ATTRIBUTE_CREATE

Declaration

public static System.Int64 ATTRIBUTE_CREATE { get; }

Property Value

Type	Description
System.Int64

DATASET_ACCESS

Declaration

public static System.Int64 DATASET_ACCESS { get; }

Property Value

Type	Description
System.Int64

DATASET_CREATE

Declaration

public static System.Int64 DATASET_CREATE { get; }

Property Value

Type	Description
System.Int64

DATASET_XFER

Declaration

public static System.Int64 DATASET_XFER { get; }

Property Value

Type	Description
System.Int64

DATATYPE_ACCESS

Declaration

public static System.Int64 DATATYPE_ACCESS { get; }

Property Value

Type	Description
System.Int64

DATATYPE_CREATE

Declaration

public static System.Int64 DATATYPE_CREATE { get; }

Property Value

Type	Description
System.Int64

FILE_ACCESS

Declaration

public static System.Int64 FILE_ACCESS { get; }

Property Value

Type	Description
System.Int64

FILE_CREATE

Declaration

public static System.Int64 FILE_CREATE { get; }

Property Value

Type	Description
System.Int64

FILE_MOUNT

Declaration

public static System.Int64 FILE_MOUNT { get; }

Property Value

Type	Description
System.Int64

GROUP_ACCESS

Declaration

public static System.Int64 GROUP_ACCESS { get; }

Property Value

Type	Description
System.Int64

GROUP_CREATE

Declaration

public static System.Int64 GROUP_CREATE { get; }

Property Value

Type	Description
System.Int64

LINK_ACCESS

Declaration

public static System.Int64 LINK_ACCESS { get; }

Property Value

Type	Description
System.Int64

LINK_CREATE

Declaration

public static System.Int64 LINK_CREATE { get; }

Property Value

Type	Description
System.Int64

LST_ATTRIBUTE_CREATE

Declaration

public static System.Int64 LST_ATTRIBUTE_CREATE { get; }

Property Value

Type	Description
System.Int64

LST_DATASET_ACCESS

Declaration

public static System.Int64 LST_DATASET_ACCESS { get; }

Property Value

Type	Description
System.Int64

LST_DATASET_CREATE

Declaration

public static System.Int64 LST_DATASET_CREATE { get; }

Property Value

Type	Description
System.Int64

LST_DATASET_XFER

Declaration

public static System.Int64 LST_DATASET_XFER { get; }

Property Value

Type	Description
System.Int64

LST_DATATYPE_ACCESS

Declaration

public static System.Int64 LST_DATATYPE_ACCESS { get; }

Property Value

Type	Description
System.Int64

LST_DATATYPE_CREATE

Declaration

public static System.Int64 LST_DATATYPE_CREATE { get; }

Property Value

Type	Description
System.Int64

LST_FILE_ACCESS

Declaration

public static System.Int64 LST_FILE_ACCESS { get; }

Property Value

Type	Description
System.Int64

LST_FILE_CREATE

Declaration

public static System.Int64 LST_FILE_CREATE { get; }

Property Value

Type	Description
System.Int64

LST_FILE_MOUNT

Declaration

public static System.Int64 LST_FILE_MOUNT { get; }

Property Value

Type	Description
System.Int64

LST_GROUP_ACCESS

Declaration

public static System.Int64 LST_GROUP_ACCESS { get; }

Property Value

Type	Description
System.Int64

LST_GROUP_CREATE

Declaration

public static System.Int64 LST_GROUP_CREATE { get; }

Property Value

Type	Description
System.Int64

LST_LINK_ACCESS

Declaration

public static System.Int64 LST_LINK_ACCESS { get; }

Property Value

Type	Description
System.Int64

LST_LINK_CREATE

Declaration

public static System.Int64 LST_LINK_CREATE { get; }

Property Value

Type	Description
System.Int64

LST_OBJECT_COPY

Declaration

public static System.Int64 LST_OBJECT_COPY { get; }

Property Value

Type	Description
System.Int64

OBJECT_COPY

Declaration

public static System.Int64 OBJECT_COPY { get; }

Property Value

Type	Description
System.Int64

OBJECT_CREATE

Declaration

public static System.Int64 OBJECT_CREATE { get; }

Property Value

Type	Description
System.Int64

ROOT

Declaration

public static System.Int64 ROOT { get; }

Property Value

Type	Description
System.Int64

STRING_CREATE

Declaration

public static System.Int64 STRING_CREATE { get; }

Property Value

Type	Description
System.Int64

Methods

add_merge_committed_dtype_path(System.Int64, Byte[])

Adds a path to the list of paths that will be searched in the destination file for a matching committed datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-AddMergeCommittedDtypePath

Declaration

public static System.Int32 add_merge_committed_dtype_path(System.Int64 ocpypl_id, byte[] path)

Parameters

Type	Name	Description
System.Int64	ocpypl_id	Object copy property list identifier.
System.Byte[]	path	The path to be added.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

add_merge_committed_dtype_path(System.Int64, String)

Adds a path to the list of paths that will be searched in the destination file for a matching committed datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-AddMergeCommittedDtypePath

Declaration

public static System.Int32 add_merge_committed_dtype_path(System.Int64 ocpypl_id, string path)

Parameters

Type	Name	Description
System.Int64	ocpypl_id	Object copy property list identifier.
System.String	path	The path to be added.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

all_filters_avail(System.Int64)

Verifies that all required filters are available. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-AllFiltersAvail

Declaration

public static System.Int32 all_filters_avail(System.Int64 plist_id)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset or group creation property list identifier.

Returns

Type	Description
System.Int32	Returns 1 if all filters are available and 0 if one or more is not currently available. Returns a negative value on error.

close(System.Int64)

Terminates access to a property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Close

Declaration

public static System.Int32 close(System.Int64 plist)

Parameters

Type	Name	Description
System.Int64	plist	Identifier of the property list to which access is terminated.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

close_class(System.Int64)

Closes an existing property list class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-CloseClass

Declaration

public static System.Int32 close_class(System.Int64 cls)

Parameters

Type	Name	Description
System.Int64	cls	Property list class to close

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

copy(System.Int64)

Copies an existing property list to create a new property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Copy

Declaration

public static System.Int64 copy(System.Int64 plist)

Parameters

Type	Name	Description
System.Int64	plist	Identifier of property list to duplicate.

Returns

Type	Description
System.Int64	Returns a property list identifier if successful; otherwise returns a negative value.

copy_prop(System.Int64, System.Int64, String)

Copies a property from one list or class to another. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-CopyProp

Declaration

public static System.Int32 copy_prop(System.Int64 dst_id, System.Int64 src_id, string name)

Parameters

Type	Name	Description
System.Int64	dst_id	Identifier of the destination property list or class
System.Int64	src_id	Identifier of the source property list or class
System.String	name	Name of the property to copy

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

create(System.Int64)

Creates a new property list as an instance of a property list class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Create

Declaration

public static System.Int64 create(System.Int64 cls_id)

Parameters

Type	Name	Description
System.Int64	cls_id	The class of the property list to create.

Returns

Type	Description
System.Int64	Returns a property list identifier ( plist ) if successful; otherwise Fail (-1).

create_class(System.Int64, String, H5P.cls_create_func_t, IntPtr, H5P.cls_copy_func_t, IntPtr, H5P.cls_close_func_t, IntPtr)

Creates a new property list class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-CreateClass

Declaration

public static System.Int64 create_class(System.Int64 parent_class, string name, H5P.cls_create_func_t create, IntPtr create_data, H5P.cls_copy_func_t copy, IntPtr copy_data, H5P.cls_close_func_t close, IntPtr close_data)

Parameters

Type	Name	Description
System.Int64	parent_class	Property list class to inherit from or NULL
System.String	name	Name of property list class to register
H5P.cls_create_func_t	create	Callback routine called when a property list is created
IntPtr	create_data	Pointer to user-defined class create data, to be passed along to class create callback
H5P.cls_copy_func_t	copy	Callback routine called when a property list is copied
IntPtr	copy_data	Pointer to user-defined class copy data, to be passed along to class copy callback
H5P.cls_close_func_t	close	Callback routine called when a property list is being closed
IntPtr	close_data	Pointer to user-defined class close data, to be passed along to class close callback

Returns

Type	Description
System.Int64	On success, returns a valid property list class identifier; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

equal(System.Int64, System.Int64)

Compares two property lists or classes for equality. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Equal

Declaration

public static System.Int32 equal(System.Int64 id1, System.Int64 id2)

Parameters

Type	Name	Description
System.Int64	id1	First property object to be compared
System.Int64	id2	Second property object to be compared

Returns

Type	Description
System.Int32	Returns 1 if equal; 0 if unequal. Returns a negative value on error.

exist(System.Int64, String)

Queries whether a property name exists in a property list or class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Exist

Declaration

public static System.Int32 exist(System.Int64 id, string name)

Parameters

Type	Name	Description
System.Int64	id	Identifier for the property to query
System.String	name	Name of property to check for

Returns

Type	Description
System.Int32	Returns 1 if the property exists in the property object; 0 if the property does not exist. Returns a negative value on error.

Remarks

ASCII strings ONLY!

free_merge_committed_dtype_paths(System.Int64)

Clears the list of paths stored in the object copy property list ocpypl_id. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-FreeMergeCommittedDtypePaths

Declaration

public static System.Int32 free_merge_committed_dtype_paths(System.Int64 ocpypl_id)

Parameters

Type	Name	Description
System.Int64	ocpypl_id	Object copy property list identifier.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get(System.Int64, String, IntPtr)

Queries the value of a property. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Get

Declaration

public static System.Int32 get(System.Int64 plid, string name, IntPtr value)

Parameters

Type	Name	Description
System.Int64	plid	Identifier of the property list to query
System.String	name	Name of property to query
IntPtr	value	Pointer to a location to which to copy the value of of the property

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

get_alignment(System.Int64, ref System.UInt64, ref System.UInt64)

Retrieves the current settings for alignment properties from a file access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetAlignment

Declaration

public static System.Int32 get_alignment(System.Int64 plist, ref System.UInt64 threshold, ref System.UInt64 alignment)

Parameters

Type	Name	Description
System.Int64	plist	Identifier of a file access property list.
System.UInt64	threshold	Pointer to location of return threshold value.
System.UInt64	alignment	Pointer to location of return alignment value.

Returns

Type	Description
System.Int32

get_alloc_time(System.Int64, ref H5D.alloc_time_t)

Retrieves the timing for storage space allocation. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetAllocTime

Declaration

public static System.Int32 get_alloc_time(System.Int64 plist_id, ref H5D.alloc_time_t alloc_time)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset creation property list identifier.
H5D.alloc_time_t	alloc_time	When to allocate dataset storage space.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_append_flush(System.Int64, UInt32, System.UInt64[], ref H5D.append_cb_t, ref IntPtr)

Retrieves the values of the append property that is set up in the dataset access property list. See https://www.hdfgroup.org/HDF5/docNewFeatures/SWMR/H5Pget_append_flush.htm

Declaration

public static System.Int32 get_append_flush(System.Int64 dapl_id, uint ndims, System.UInt64[] boundary, ref H5D.append_cb_t func, ref IntPtr udata)

Parameters

Type	Name	Description
System.Int64	dapl_id	Dataset access property list identifier.
System.UInt32	ndims	The number of elements for boundary.
System.UInt64[]	boundary	The dimension sizes used to determine the boundary.
H5D.append_cb_t	func	The user-defined callback function.
IntPtr	udata	The user-defined input data.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_attr_creation_order(System.Int64, ref UInt32)

Retrieves tracking and indexing settings for attribute creation order. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetAttrCreationOrder

Declaration

public static System.Int32 get_attr_creation_order(System.Int64 ocpl_id, ref uint crt_order_flags)

Parameters

Type	Name	Description
System.Int64	ocpl_id	Object (group or dataset) creation property list identifier
System.UInt32	crt_order_flags	Flags specifying whether to track and index attribute creation order

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_attr_phase_change(System.Int64, ref UInt32, ref UInt32)

Retrieves attribute storage phase change thresholds. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetAttrPhaseChange

Declaration

public static System.Int32 get_attr_phase_change(System.Int64 ocpl_id, ref uint max_compact, ref uint min_dense)

Parameters

Type	Name	Description
System.Int64	ocpl_id	Object creation property list identifier
System.UInt32	max_compact	Maximum number of attributes to be stored in compact storage
System.UInt32	min_dense	Minimum number of attributes to be stored in dense storage

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_btree_ratios(System.Int64, ref Double, ref Double, ref Double)

Gets B-tree split ratios for a dataset transfer property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetBTreeRatios

Declaration

public static System.Int32 get_btree_ratios(System.Int64 plist, ref double left, ref double middle, ref double right)

Parameters

Type	Name	Description
System.Int64	plist	The dataset transfer property list identifier.
System.Double	left	The B-tree split ratio for left-most nodes.
System.Double	middle	The B-tree split ratio for right-most nodes and lone nodes.
System.Double	right	The B-tree split ratio for all other nodes.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_buffer(System.Int64, ref IntPtr, ref IntPtr)

Reads buffer settings. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetBuffer

Declaration

public static System.UInt64 get_buffer(System.Int64 plist, ref IntPtr tconv, ref IntPtr bkg)

Parameters

Type	Name	Description
System.Int64	plist	Identifier for the dataset transfer property list.
IntPtr	tconv	Address of the pointer to application-allocated type conversion buffer.
IntPtr	bkg	Address of the pointer to application-allocated background buffer.

Returns

Type	Description
System.UInt64	Returns buffer size, in bytes, if successful; otherwise 0 on failure.

get_cache(System.Int64, ref Int32, ref System.IntPtr, ref System.IntPtr, ref Double)

Queries the raw data chunk cache parameters. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetCache

Declaration

public static System.Int32 get_cache(System.Int64 plist_id, ref int mdc_nelmts, ref System.IntPtr rdcc_nelmts, ref System.IntPtr rdcc_nbytes, ref double rdcc_w0)

Parameters

Type	Name	Description
System.Int64	plist_id	Identifier of the file access property list.
System.Int32	mdc_nelmts	UNUSED.
System.IntPtr	rdcc_nelmts	Number of elements (objects) in the raw data chunk cache.
System.IntPtr	rdcc_nbytes	Total size of the raw data chunk cache, in bytes.
System.Double	rdcc_w0	Preemption policy.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_char_encoding(System.Int64, ref H5T.cset_t)

Retrieves the character encoding used to create a link or attribute name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetCharEncoding

Declaration

public static System.Int32 get_char_encoding(System.Int64 plist_id, ref H5T.cset_t encoding)

Parameters

Type	Name	Description
System.Int64	plist_id	Link creation or attribute creation property list identifier
H5T.cset_t	encoding	String encoding character set

Returns

Type	Description
System.Int32	Returns a non-negative valule if successful; otherwise returns a negative value.

get_chunk(System.Int64, Int32, System.UInt64[])

Retrieves the size of chunks for the raw data of a chunked layout dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetChunk

Declaration

public static int get_chunk(System.Int64 plist_id, int max_ndims, System.UInt64[] dims)

Parameters

Type	Name	Description
System.Int64	plist_id	Identifier of property list to query.
System.Int32	max_ndims	Length of the dims array.
System.UInt64[]	dims	Array to store the chunk dimensions.

Returns

Type	Description
System.Int32	Returns chunk dimensionality if successful; otherwise returns a negative value.

get_chunk_cache(System.Int64, ref System.IntPtr, ref System.IntPtr, ref Double)

Retrieves the raw data chunk cache parameters. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetChunkCache

Declaration

public static System.Int32 get_chunk_cache(System.Int64 dapl_id, ref System.IntPtr rdcc_nslots, ref System.IntPtr rdcc_nbytes, ref double rdcc_w0)

Parameters

Type	Name	Description
System.Int64	dapl_id	Dataset access property list identifier.
System.IntPtr	rdcc_nslots	Number of chunk slots in the raw data chunk cache hash table.
System.IntPtr	rdcc_nbytes	Total size of the raw data chunk cache, in bytes.
System.Double	rdcc_w0	Preemption policy.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_chunk_opts(System.Int64, ref UInt32)

Retrieves the edge chunk option setting from a dataset creation property list. See https://www.hdfgroup.org/HDF5/docNewFeatures/PartialEdgeChunks/H5Pget_chunk_opts.htm

Declaration

public static System.Int32 get_chunk_opts(System.Int64 dcpl_id, ref uint opts)

Parameters

Type	Name	Description
System.Int64	dcpl_id	Dataset creation property list identifier.
System.UInt32	opts	Edge chunk option flag.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_class(System.Int64)

Returns the property list class identifier for a property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetClass

Declaration

public static System.Int64 get_class(System.Int64 plist)

Parameters

Type	Name	Description
System.Int64	plist	Identifier of property list to query.

Returns

Type	Description
System.Int64	Returns a property list class identifier if successful. Otherwise returns a negative value.

get_class_name(System.Int64)

Retrieves the name of a class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetClassName

Declaration

public static IntPtr get_class_name(System.Int64 pcid)

Parameters

Type	Name	Description
System.Int64	pcid	Identifier of the property class to query

Returns

Type	Description
IntPtr	If successful returns a pointer to an allocated string containing the class name; NULL if unsuccessful.

Remarks

The pointer to the name must be freed by the user after each successful call.

get_class_parent(System.Int64)

Retrieves the parent class of a property class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetClassParent

Declaration

public static System.Int64 get_class_parent(System.Int64 pcid)

Parameters

Type	Name	Description
System.Int64	pcid	Identifier of the property class to query

Returns

Type	Description
System.Int64	If successful, returns a valid parent class object identifier; returns a negative value on failure.

get_copy_object(System.Int64, ref UInt32)

Retrieves the properties to be used when an object is copied. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetCopyObject

Declaration

public static System.Int32 get_copy_object(System.Int64 ocp_plist_id, ref uint copy_options)

Parameters

Type	Name	Description
System.Int64	ocp_plist_id	Object copy property list identifier
System.UInt32	copy_options	Copy option(s) set in the object copy property list

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_core_write_tracking(System.Int64, ref System.UInt32, ref System.IntPtr)

Gets information about the write tracking feature used by the core VFD. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetCoreWriteTracking

Declaration

public static System.Int32 get_core_write_tracking(System.Int64 fapl_id, ref System.UInt32 is_enabled, ref System.IntPtr page_size)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
System.UInt32	is_enabled	Whether the feature is enabled.
System.IntPtr	page_size	Size, in bytes, of write aggregation pages.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful. Otherwise returns a negative value.

get_create_intermediate_group(System.Int64, ref UInt32)

Determines whether property is set to enable creating missing intermediate groups. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetCreateIntermediateGroup

Declaration

public static System.Int32 get_create_intermediate_group(System.Int64 lcpl_id, ref uint crt_intermed_group)

Parameters

Type	Name	Description
System.Int64	lcpl_id	Link creation property list identifier
System.UInt32	crt_intermed_group	Flag specifying whether to create intermediate groups upon creation of an object

Returns

Type	Description
System.Int32	Returns a non-negative valule if successful; otherwise returns a negative value.

get_data_transform(System.Int64, StringBuilder, System.IntPtr)

Retrieves a data transform expression. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetDataTransform

Declaration

public static System.IntPtr get_data_transform(System.Int64 plist_id, StringBuilder expression, System.IntPtr size)

Parameters

Type	Name	Description
System.Int64	plist_id	Identifier of the property list or class
StringBuilder	expression	Pointer to memory where the transform expression will be copied
System.IntPtr	size	Number of bytes of the transform expression to copy to

Returns

Type	Description
System.IntPtr	If successful, returns the size of the transform expression. Otherwise returns a negative value.

get_driver(System.Int64)

Returns low-lever driver identifier. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetDriver

Declaration

public static System.Int64 get_driver(System.Int64 plist_id)

Parameters

Type	Name	Description
System.Int64	plist_id	File access or data transfer property list identifier.

Returns

Type	Description
System.Int64	Returns a valid low-level driver identifier if successful. Otherwise returns a negative value.

get_driver_info(System.Int64)

Returns a pointer to file driver information. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetDriverInfo

Declaration

public static IntPtr get_driver_info(System.Int64 plist_id)

Parameters

Type	Name	Description
System.Int64	plist_id	File access or data transfer property list identifier.

Returns

Type	Description
IntPtr	Returns a pointer to a struct containing low-level driver information. Otherwise returns NULL .

Remarks

NULL

is also returned if no driver-specific

properties have been registered. No error is pushed on the stack
in this case.

get_dset_no_attrs_hint(System.Int64, ref System.UInt32)

Retrieves the setting for whether or not a file will create minimized dataset object headers. See https://portal.hdfgroup.org/display/HDF5/H5P_GET_DSET_NO_ATTRS_HINT

Declaration

public static System.Int32 get_dset_no_attrs_hint(System.Int64 plist_id, ref System.UInt32 minimize)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset creation property list identifier
System.UInt32	minimize	Flag indicating whether the library will or will not create minimized dataset object headers

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_edc_check(System.Int64)

Determines whether error-detection is enabled for dataset reads. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetEdcCheck

Declaration

public static H5Z.EDC_t get_edc_check(System.Int64 plist)

Parameters

Type	Name	Description
System.Int64	plist	Dataset transfer property list identifier.

Returns

Type	Description
H5Z.EDC_t	Returns H5Z_ENABLE_EDC or H5Z_DISABLE_EDC if successful; otherwise returns a negative value.

get_efile_prefix(System.Int64, Byte[], System.IntPtr)

Retrieves the prefix for external raw data storage files as set in the dataset access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetEfilePrefix

Declaration

public static System.IntPtr get_efile_prefix(System.Int64 dapl, byte[] prefix, System.IntPtr size)

Parameters

Type	Name	Description
System.Int64	dapl	Dataset access property list identifier.
System.Byte[]	prefix	Dataset external storage prefix.
System.IntPtr	size	Size of prefix buffer in bytes.

Returns

Type	Description
System.IntPtr	Returns the size of prefix and the prefix string will be stored in prefix if successful. Otherwise returns a negative value and the contents of prefix will be undefined.

get_elink_acc_flags(System.Int64, ref UInt32)

Retrieves the external link traversal file access flag from the specified link access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetELinkAccFlags

Declaration

public static System.Int32 get_elink_acc_flags(System.Int64 lapl_id, ref uint flags)

Parameters

Type	Name	Description
System.Int64	lapl_id	Link access property list identifier
System.UInt32	flags	File access flag for link traversal.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value

get_elink_cb(System.Int64, ref H5L.elink_traverse_t, ref IntPtr)

Retrieves the external link traversal callback function from the specified link access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetELinkCb

Declaration

public static System.Int32 get_elink_cb(System.Int64 lapl_id, ref H5L.elink_traverse_t func, ref IntPtr op_data)

Parameters

Type	Name	Description
System.Int64	lapl_id	Link access property list identifier.
H5L.elink_traverse_t	func	User-defined external link traversal callback function.
IntPtr	op_data	User-defined input data for the callback function.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_elink_fapl(System.Int64)

Retrieves the file access property list identifier associated with the link access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetELinkFapl

Declaration

public static System.Int64 get_elink_fapl(System.Int64 lapl_id)

Parameters

Type	Name	Description
System.Int64	lapl_id	Link access property list identifier.

Returns

Type	Description
System.Int64	Returns a non-negative value if successful; otherwise returns a negative value.

get_elink_file_cache_size(System.Int64, ref UInt32)

Retrieves the size of the external link open file cache. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetELinkFileCacheSize

Declaration

public static System.Int32 get_elink_file_cache_size(System.Int64 fapl_id, ref uint efc_size)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier
System.UInt32	efc_size	External link open file cache size in number of files.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_elink_prefix(System.Int64, Byte[], System.IntPtr)

Retrieves prefix applied to external link paths. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetELinkPrefix

Declaration

public static System.IntPtr get_elink_prefix(System.Int64 lapl_id, byte[] prefix, System.IntPtr size)

Parameters

Type	Name	Description
System.Int64	lapl_id	Link access property list identifier
System.Byte[]	prefix	Prefix applied to external link paths
System.IntPtr	size	Size of prefix, including null terminator

Returns

Type	Description
System.IntPtr	If successful, returns a non-negative value specifying the size in bytes of the prefix without the NULL terminator; otherwise returns a negative value.

get_est_link_info(System.Int64, ref UInt32, ref UInt32)

Queries data required to estimate required local heap or object header size. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetEstLinkInfo

Declaration

public static System.Int32 get_est_link_info(System.Int64 gcpl_id, ref uint est_num_entries, ref uint est_name_len)

Parameters

Type	Name	Description
System.Int64	gcpl_id	Group creation property list identifier
System.UInt32	est_num_entries	Estimated number of links to be inserted into group
System.UInt32	est_name_len	Estimated average length of link names

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_external(System.Int64, UInt32, System.IntPtr, Byte[], ref System.IntPtr, ref System.UInt64)

Returns information about an external file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetExternal

Declaration

public static System.Int32 get_external(System.Int64 plist, uint idx, System.IntPtr name_size, byte[] name, ref System.IntPtr offset, ref System.UInt64 size)

Parameters

Type	Name	Description
System.Int64	plist	Identifier of a dataset creation property list.
System.UInt32	idx	External file index.
System.IntPtr	name_size	Maximum length of name array.
System.Byte[]	name	Name of the external file.
System.IntPtr	offset	Pointer to a location to return an offset value.
System.UInt64	size	Pointer to a location to return the size of the external file data.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_external_count(System.Int64)

Returns the number of external files for a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetExternalCount

Declaration

public static int get_external_count(System.Int64 plist)

Parameters

Type	Name	Description
System.Int64	plist	Identifier of a dataset creation property list.

Returns

Type	Description
System.Int32	Returns the number of external files if successful; otherwise returns a negative value.

get_family_offset(System.Int64, ref System.UInt64)

Retrieves a data offset from the file access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFamilyOffset

Declaration

public static System.Int32 get_family_offset(System.Int64 fapl_id, ref System.UInt64 offset)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
System.UInt64	offset	Offset in bytes within the HDF5 file.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_fapl_core(System.Int64, ref System.IntPtr, ref System.UInt32)

Queries core file driver properties. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFaplCore

Declaration

public static System.Int32 get_fapl_core(System.Int64 fapl_id, ref System.IntPtr increment, ref System.UInt32 backing_store)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
System.IntPtr	increment	Size, in bytes, of memory increments.
System.UInt32	backing_store	Boolean flag indicating whether to write the file contents to disk when the file is closed.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful. Otherwise returns a negative value.

get_fapl_direct(System.Int64, ref System.IntPtr, ref System.IntPtr, ref System.IntPtr)

Retrieves direct I/O driver settings. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFaplDirect

Declaration

public static System.Int32 get_fapl_direct(System.Int64 fapl_id, ref System.IntPtr alignment, ref System.IntPtr block_size, ref System.IntPtr cbuf_size)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier
System.IntPtr	alignment	Required memory alignment boundary
System.IntPtr	block_size	File system block size
System.IntPtr	cbuf_size	Copy buffer size

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_fapl_family(System.Int64, ref System.UInt64, ref System.Int64)

Returns file access property list information. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFaplFamily

Declaration

public static System.Int32 get_fapl_family(System.Int64 fapl_id, ref System.UInt64 memb_size, ref System.Int64 memb_fapl_id)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
System.UInt64	memb_size	Size in bytes of each file member.
System.Int64	memb_fapl_id	Identifier of file access property list for each family member.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_fclose_degree(System.Int64, ref H5F.close_degree_t)

Returns the file close degree. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFcloseDegree

Declaration

public static System.Int32 get_fclose_degree(System.Int64 fapl_id, ref H5F.close_degree_t fc_degree)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
H5F.close_degree_t	fc_degree	Pointer to a location to which to return the file close degree property, the value of fc_degree .

Returns

Type	Description
System.Int32	Returns a non-negative value if successful. Otherwise returns a negative value.

get_file_image(System.Int64, ref IntPtr, ref System.IntPtr)

Retrieves a copy of the file image designated as the initial content and structure of a file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFileImage

Declaration

public static System.Int32 get_file_image(System.Int64 fapl_id, ref IntPtr buf_ptr_ptr, ref System.IntPtr buf_len_ptr)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
IntPtr	buf_ptr_ptr	On input, NULL or a pointer to a pointer to a buffer that contains the file image.
System.IntPtr	buf_len_ptr	On input, NULL or a pointer to a buffer specifying the required size of the buffer to hold the file image.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_file_image_callbacks(System.Int64, ref H5FD.file_image_callbacks_t)

Retrieves callback routines for working with file images. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFileImageCallbacks

Declaration

public static System.Int32 get_file_image_callbacks(System.Int64 fapl_id, ref H5FD.file_image_callbacks_t callbacks_ptr)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
H5FD.file_image_callbacks_t	callbacks_ptr	Pointer to the instance of the H5FD.file_image_callbacks_t struct in which the callback routines are to be returned.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

Remarks

Struct fields must be initialized to

NULL

before the call is made.

get_file_space(System.Int64, ref H5F.file_space_type_t, ref System.UInt64)

Retrieves the file space management strategy and/or free-space section threshold for an HDF5 file. See https://www.hdfgroup.org/HDF5/docNewFeatures/FileSpace/H5Pget_file_space.htm

Declaration

public static System.Int32 get_file_space(System.Int64 fcpl, ref H5F.file_space_type_t strategy, ref System.UInt64 threshold)

Parameters

Type	Name	Description
System.Int64	fcpl	The file creation property list identifier.
H5F.file_space_type_t	strategy	The current file space management strategy in use for the file.
System.UInt64	threshold	The current free-space section threshold.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_file_space_page_size(System.Int64, ref System.UInt64)

Retrieves the file space page size for a file creation property list. See https://support.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFileSpacePageSize

Declaration

public static System.Int32 get_file_space_page_size(System.Int64 fcpl, ref System.UInt64 fsp_size)

Parameters

Type	Name	Description
System.Int64	fcpl	The file creation property list identifier.
System.UInt64	fsp_size	File space page size

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_file_space_strategy(System.Int64, ref H5F.fspace_strategy_t, ref System.UInt32, ref System.UInt64)

Retrieves the file space handling strategy, persisting free-space condition and threshold value for a file creation property list. See https://support.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFileSpaceStrategy

Declaration

public static System.Int32 get_file_space_strategy(System.Int64 fcpl, ref H5F.fspace_strategy_t strategy, ref System.UInt32 persist, ref System.UInt64 threshold)

Parameters

Type	Name	Description
System.Int64	fcpl	The file creation property list identifier.
H5F.fspace_strategy_t	strategy	The current file space management strategy in use for the file.
System.UInt32	persist	The boolean value indicating whether free space is persistent or not.
System.UInt64	threshold	The free-space section size threshold value.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_fill_time(System.Int64, ref H5D.fill_time_t)

Retrieves the time when fill value are written to a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFillTime

Declaration

public static System.Int32 get_fill_time(System.Int64 plist_id, ref H5D.fill_time_t fill_time)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset creation property list identifier.
H5D.fill_time_t	fill_time	Setting for the timing of writing fill values to the dataset.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_fill_value(System.Int64, System.Int64, IntPtr)

Retrieves a dataset fill value. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFillValue

Declaration

public static System.Int32 get_fill_value(System.Int64 plist_id, System.Int64 type_id, IntPtr value)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset creation property list identifier.
System.Int64	type_id	Datatype identifier for the value passed via value .
IntPtr	value	Pointer to buffer to contain the returned fill value.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_filter(System.Int64, UInt32, ref UInt32, ref System.IntPtr, UInt32[], System.IntPtr, Byte[], ref UInt32)

Returns information about a filter in a pipeline. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFilter2

Declaration

public static H5Z.filter_t get_filter(System.Int64 plist_id, uint idx, ref uint flags, ref System.IntPtr cd_nelmts, uint[] cd_values, System.IntPtr namelen, byte[] name, ref uint filter_config)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset or group creation property list identifier.
System.UInt32	idx	Sequence number within the filter pipeline of the filter for which information is sought.
System.UInt32	flags	Bit vector specifying certain general properties of the filter.
System.IntPtr	cd_nelmts	Number of elements in cd_values.
System.UInt32[]	cd_values	Auxiliary data for the filter.
System.IntPtr	namelen	Anticipated number of characters in name.
System.Byte[]	name	Name of the filter.
System.UInt32	filter_config	Bit field.

Returns

Type	Description
H5Z.filter_t	Returns the filter identifier if successful. Otherwise returns a negative value.

get_filter_by_id(System.Int64, H5Z.filter_t, ref UInt32, ref System.IntPtr, UInt32[], System.IntPtr, Byte[], ref UInt32)

Returns information about the specified filter. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFilterById2

Declaration

public static System.Int32 get_filter_by_id(System.Int64 plist_id, H5Z.filter_t filter_id, ref uint flags, ref System.IntPtr cd_nelmts, uint[] cd_values, System.IntPtr namelen, byte[] name, ref uint filter_config)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset or group creation property list identifier.
H5Z.filter_t	filter_id	Filter identifier.
System.UInt32	flags	Bit vector specifying certain general properties of the filter.
System.IntPtr	cd_nelmts	Number of elements in cd_values.
System.UInt32[]	cd_values	Auxiliary data for the filter.
System.IntPtr	namelen	Anticipated number of characters in name.
System.Byte[]	name	Name of the filter.
System.UInt32	filter_config	Bit field.

Returns

Type	Description
System.Int32	Returns the filter identifier if successful. Otherwise returns a negative value.

get_filter2(System.Int64, UInt32, ref UInt32, ref System.UInt64, UInt32*, System.IntPtr, String, ref UInt32)

Returns information about a filter in a pipeline. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetFilter2

Declaration

public static H5Z.filter_t get_filter2(System.Int64 plist_id, uint filter, ref uint flags, ref System.UInt64 cd_nelmts, uint *cd_values, System.IntPtr namelen, string name, ref uint filter_config)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset or group creation property list identifier.
System.UInt32	filter	Sequence number within the filter pipeline of the filter for which information is sought.
System.UInt32	flags	Bit vector specifying certain general properties of the filter.
System.UInt64	cd_nelmts	Number of elements in cd_values.
System.UInt32*	cd_values	Auxiliary data for the filter.
System.IntPtr	namelen	Anticipated number of characters in name.
System.String	name	Name of the filter.
System.UInt32	filter_config	Bit field.

Returns

Type	Description
H5Z.filter_t	Returns the filter identifier if successful. Otherwise returns a negative value.

get_gc_references(System.Int64, ref UInt32)

Returns garbage collecting references setting. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetGCReferences

Declaration

public static System.Int32 get_gc_references(System.Int64 plist, ref uint gc_ref)

Parameters

Type	Name	Description
System.Int64	plist	File access property list identifier.
System.UInt32	gc_ref	Flag returning the state of reference garbage collection. A returned value of 1 indicates that garbage collection is on while 0 indicates that garbage collection is off.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_hyper_vector_size(System.Int64, ref System.IntPtr)

Retrieves number of I/O vectors to be read/written in hyperslab I/O. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetHyperVectorSize

Declaration

public static System.Int32 get_hyper_vector_size(System.Int64 dxpl_id, ref System.IntPtr vector_size)

Parameters

Type	Name	Description
System.Int64	dxpl_id	Dataset transfer property list identifier.
System.IntPtr	vector_size	Number of I/O vectors to accumulate in memory for I/O operations.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_istore_k(System.Int64, ref UInt32)

Queries the 1/2 rank of an indexed storage B-tree. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetIstoreK

Declaration

public static System.Int32 get_istore_k(System.Int64 fcpl_id, ref uint ik)

Parameters

Type	Name	Description
System.Int64	fcpl_id	File creation property list identifier
System.UInt32	ik	Pointer to location to return the chunked storage B-tree 1/2 rank

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_layout(System.Int64)

Returns the layout of the raw data for a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetLayout

Declaration

public static H5D.layout_t get_layout(System.Int64 plist)

Parameters

Type	Name	Description
System.Int64	plist	Identifier for property list to query.

Returns

Type	Description
H5D.layout_t	Returns the layout type (a non-negative value) of a dataset creation property list if successful. Otherwise, returns a negative value indicating failure.

get_libver_bounds(System.Int64, ref H5F.libver_t, ref H5F.libver_t)

Retrieves library version bounds settings that indirectly control the format versions used when creating objects. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetLibverBounds

Declaration

public static System.Int32 get_libver_bounds(System.Int64 fapl_id, ref H5F.libver_t libver_low, ref H5F.libver_t libver_high)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier
H5F.libver_t	libver_low	The earliest version of the library that will be used for writing objects.
H5F.libver_t	libver_high	The latest version of the library that will be used for writing objects.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_link_creation_order(System.Int64, ref UInt32)

Queries whether link creation order is tracked and/or indexed in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetLinkCreationOrder

Declaration

public static System.Int32 get_link_creation_order(System.Int64 gcpl_id, ref uint crt_order_flags)

Parameters

Type	Name	Description
System.Int64	gcpl_id	Group creation property list identifier
System.UInt32	crt_order_flags	Creation order flag(s)

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_link_phase_change(System.Int64, ref UInt32, ref UInt32)

Queries the settings for conversion between compact and dense groups. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetLinkPhaseChange

Declaration

public static System.Int32 get_link_phase_change(System.Int64 gcpl_id, ref uint max_compact, ref uint min_dense)

Parameters

Type	Name	Description
System.Int64	gcpl_id	Group creation property list identifier
System.UInt32	max_compact	Maximum number of links for compact storage
System.UInt32	min_dense	Minimum number of links for dense storage

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_local_heap_size_hint(System.Int64, ref System.IntPtr)

Retrieves the anticipated size of the local heap for original-style groups. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetLocalHeapSizeHint

Declaration

public static System.Int32 get_local_heap_size_hint(System.Int64 gcpl_id, ref System.IntPtr size_hint)

Parameters

Type	Name	Description
System.Int64	gcpl_id	Group creation property list identifier
System.IntPtr	size_hint	Anticipated size of local heap

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_mcdt_search_cb(System.Int64, ref H5O.mcdt_search_cb_t, ref IntPtr)

Retrieves the callback function from the specified object copy property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetMcdtSearchCb

Declaration

public static System.Int32 get_mcdt_search_cb(System.Int64 ocpypl_id, ref H5O.mcdt_search_cb_t func, ref IntPtr op_data)

Parameters

Type	Name	Description
System.Int64	ocpypl_id	Object copy property list identifier
H5O.mcdt_search_cb_t	func	User-defined callback function
IntPtr	op_data	User-defined input data for the callback function

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_mdc_config(System.Int64, IntPtr)

Get the current initial metadata cache configuration from the indicated File Access Property List. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetMdcConfig

Declaration

public static System.Int32 get_mdc_config(System.Int64 plist_id, IntPtr config_ptr)

Parameters

Type	Name	Description
System.Int64	plist_id	Identifier of the file access property list.
IntPtr	config_ptr	Pointer to the instance of H5AC.cache_config_t in which the current metadata cache configuration is to be reported.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_mdc_image_config(System.Int64, IntPtr)

Retrieves the metadata cache image configuration values for a file access property list. See https://support.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetMDCImageConfig

Declaration

public static System.Int32 get_mdc_image_config(System.Int64 fapl_id, IntPtr config_ptr)

Parameters

Type	Name	Description
System.Int64	fapl_id	Identifier of the file access property list.
IntPtr	config_ptr	Reference to the instance of H5AC.cache_image_config_t in which the current metadata cache image configuration is to be reported.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_mdc_log_options(System.Int64, ref System.UInt32, StringBuilder, ref System.IntPtr, ref System.UInt32)

Gets metadata cache logging options. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Pget_mdc_log_options.htm

Declaration

public static System.Int32 get_mdc_log_options(System.Int64 fapl_id, ref System.UInt32 is_enabled, StringBuilder location, ref System.IntPtr location_size, ref System.UInt32 start_on_access)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
System.UInt32	is_enabled	Whether logging is enabled.
StringBuilder	location	Log file location.
System.IntPtr	location_size	Size in bytes of the location string.
System.UInt32	start_on_access	Whether the logging begins as soon as the file is opened or created.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful. Otherwise returns a negative value.

Remarks

ASCII strings ONLY!

get_meta_block_size(System.Int64, ref System.UInt64)

Returns the current metadata block size setting. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetMetaBlockSize

Declaration

public static System.Int32 get_meta_block_size(System.Int64 fapl_id, ref System.UInt64 size)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
System.UInt64	size	Minimum size, in bytes, of metadata block allocations.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful. Otherwise returns a negative value.

get_metadata_read_attempts(System.Int64, ref UInt32)

Retrieves the number of read attempts from a file access property list. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Pget_metadata_read_attempts.htm

Declaration

public static System.Int32 get_metadata_read_attempts(System.Int64 fapl, ref uint attempts)

Parameters

Type	Name	Description
System.Int64	fapl	Identifier for a file access property list.
System.UInt32	attempts	The number of read attempts.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_nfilters(System.Int64)

Returns the number of filters in the pipeline. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetNFilters

Declaration

public static int get_nfilters(System.Int64 plist)

Parameters

Type	Name	Description
System.Int64	plist	Property list identifier.

Returns

Type	Description
System.Int32	Returns the number of filters in the pipeline if successful; otherwise returns a negative value.

get_nlinks(System.Int64, ref System.IntPtr)

Retrieves the maximum number of link traversals. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetNLinks

Declaration

public static System.Int32 get_nlinks(System.Int64 lapl_id, ref System.IntPtr nlinks)

Parameters

Type	Name	Description
System.Int64	lapl_id	File access property list identifier
System.IntPtr	nlinks	Maximum number of links to traverse

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_nprops(System.Int64, ref System.IntPtr)

Queries the number of properties in a property list or class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetNProps

Declaration

public static System.Int32 get_nprops(System.Int64 plist_id, ref System.IntPtr nprops)

Parameters

Type	Name	Description
System.Int64	plist_id	Identifier for property object to query
System.IntPtr	nprops	Number of properties in object

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_obj_track_times(System.Int64, ref System.UInt32)

Determines whether times associated with an object are being recorded. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetObjTrackTimes

Declaration

public static System.Int32 get_obj_track_times(System.Int64 ocpl_id, ref System.UInt32 track_times)

Parameters

Type	Name	Description
System.Int64	ocpl_id	Object creation property list identifier
System.UInt32	track_times	Boolean value, 1 or 0, specifying whether object times are being recorded

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_object_flush_cb(System.Int64, ref H5F.flush_cb_t, ref IntPtr)

Retrieves the object flush property values from the file access property list. See https://www.hdfgroup.org/HDF5/docNewFeatures/SWMR/H5Pget_object_flush_cb.htm

Declaration

public static System.Int32 get_object_flush_cb(System.Int64 fapl_id, ref H5F.flush_cb_t func, ref IntPtr udata)

Parameters

Type	Name	Description
System.Int64	fapl_id	Identifier for a file access property list.
H5F.flush_cb_t	func	The user-defined callback function.
IntPtr	udata	The user-defined input data for the callback function.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_page_buffer_size(System.Int64, ref IntPtr, ref UInt32, ref UInt32)

Retrieves the maximum size for the page buffer and the minimum percentage for metadata and raw data pages. See https://support.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetPageBufferSize

Declaration

public static System.Int32 get_page_buffer_size(System.Int64 fapl_id, ref IntPtr buf_size, ref uint min_meta_perc, ref uint min_raw_perc)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier
IntPtr	buf_size	Maximum size, in bytes, of the page buffer
System.UInt32	min_meta_perc	Minimum metadata percentage to keep in the page buffer before allowing pages containing metadata to be evicted
System.UInt32	min_raw_perc	Minimum raw data percentage to keep in the page buffer before allowing pages containing raw data to be evicted

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_shared_mesg_index(System.Int64, UInt32, ref UInt32, ref UInt32)

Retrieves the configuration settings for a shared message index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetSharedMesgIndex

Declaration

public static System.Int32 get_shared_mesg_index(System.Int64 fcpl_id, uint index_num, ref uint mesg_type_flags, ref uint min_mesg_size)

Parameters

Type	Name	Description
System.Int64	fcpl_id	File creation property list identifier.
System.UInt32	index_num	Index being configured.
System.UInt32	mesg_type_flags	Types of messages that may be stored in this index.
System.UInt32	min_mesg_size	Minimum message size.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_shared_mesg_nindexes(System.Int64, ref UInt32)

Retrieves number of shared object header message indexes in file creation property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetSharedMesgNIndexes

Declaration

public static System.Int32 get_shared_mesg_nindexes(System.Int64 fcpl_id, ref uint nindexes)

Parameters

Type	Name	Description
System.Int64	fcpl_id	File creation property list
System.UInt32	nindexes	Number of shared object header message indexes available in files created with this property list

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_shared_mesg_phase_change(System.Int64, ref UInt32, ref UInt32)

Retrieves shared object header message phase change information. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetSharedMesgPhaseChange

Declaration

public static System.Int32 get_shared_mesg_phase_change(System.Int64 fcpl_id, ref uint max_list, ref uint min_btree)

Parameters

Type	Name	Description
System.Int64	fcpl_id	File creation property list identifier
System.UInt32	max_list	Threshold above which storage of a shared object header message index shifts from list to B-tree
System.UInt32	min_btree	Threshold below which storage of a shared object header message index reverts to list format

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_sieve_buf_size(System.Int64, ref System.IntPtr)

Returns maximum data sieve buffer size. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetSieveBufSize

Declaration

public static System.Int32 get_sieve_buf_size(System.Int64 fapl_id, ref System.IntPtr size)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
System.IntPtr	size	Maximum size, in bytes, of data sieve buffer.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful. Otherwise returns a negative value.

get_size(System.Int64, String, ref System.IntPtr)

Queries the size of a property value in bytes. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetSize

Declaration

public static int get_size(System.Int64 id, string name, ref System.IntPtr size)

Parameters

Type	Name	Description
System.Int64	id	Identifier of property object to query
System.String	name	Name of property to query
System.IntPtr	size	Size of property in bytes

Returns

Type	Description
System.Int32	Returns a non-negative value if successful. Otherwise returns a negative value.

Remarks

ASCII strings ONLY!

get_sizes(System.Int64, ref System.IntPtr, ref System.IntPtr)

Retrieves the size of the offsets and lengths used in an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetSizes

Declaration

public static System.Int32 get_sizes(System.Int64 plist, ref System.IntPtr sizeof_addr, ref System.IntPtr sizeof_size)

Parameters

Type	Name	Description
System.Int64	plist	Identifier of property list to query.
System.IntPtr	sizeof_addr	Pointer to location to return offset size in bytes.
System.IntPtr	sizeof_size	Pointer to location to return length size in bytes.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_small_data_block_size(System.Int64, ref System.UInt64)

Retrieves the current small data block size setting. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetSmallData

Declaration

public static System.Int32 get_small_data_block_size(System.Int64 fapl_id, ref System.UInt64 size)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
System.UInt64	size	Maximum size, in bytes, of the small data block.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise a negative value.

get_sym_k(System.Int64, ref UInt32, ref UInt32)

Retrieves the size of the symbol table B-tree 1/2 rank and the symbol table leaf node 1/2 size. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetSymK

Declaration

public static System.Int32 get_sym_k(System.Int64 fcpl_id, ref uint ik, ref uint lk)

Parameters

Type	Name	Description
System.Int64	fcpl_id	File creation property list identifier
System.UInt32	ik	Pointer to location to return the symbol table's B-tree 1/2 rank
System.UInt32	lk	Pointer to location to return the symbol table's leaf node 1/2 size

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_type_conv_cb(System.Int64, ref H5T.conv_except_func_t, ref IntPtr)

Gets user-defined datatype conversion callback function. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetTypeConvCb

Declaration

public static System.Int32 get_type_conv_cb(System.Int64 plist, ref H5T.conv_except_func_t func, ref IntPtr op_data)

Parameters

Type	Name	Description
System.Int64	plist	Dataset transfer property list identifier.
H5T.conv_except_func_t	func	User-defined type conversion callback function.
IntPtr	op_data	User-defined input data for the callback function.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_userblock(System.Int64, ref System.UInt64)

Retrieves the size of a user block. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetUserblock

Declaration

public static System.Int32 get_userblock(System.Int64 plist, ref System.UInt64 size)

Parameters

Type	Name	Description
System.Int64	plist	Identifier for property list to query.
System.UInt64	size	Pointer to location to return user-block size.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_version(System.Int64, ref UInt32, ref UInt32, ref UInt32, ref UInt32)

Retrieves the version information of various objects for a file creation property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetVersion

Declaration

public static System.Int32 get_version(System.Int64 plist, ref uint super, ref uint freelist, ref uint stab, ref uint shhdr)

Parameters

Type	Name	Description
System.Int64	plist	Identifier of the file creation property list.
System.UInt32	super	Pointer to location to return super block version number.
System.UInt32	freelist	Pointer to location to return global freelist version number.
System.UInt32	stab	Pointer to location to return symbol table version number.
System.UInt32	shhdr	Pointer to location to return shared object header version number.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_virtual_count(System.Int64, ref System.IntPtr)

Gets the number of mappings for the virtual dataset. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pget_virtual_count.htm

Declaration

public static System.Int32 get_virtual_count(System.Int64 dcpl_id, ref System.IntPtr count)

Parameters

Type	Name	Description
System.Int64	dcpl_id	The identifier of the virtual dataset creation property list.
System.IntPtr	count	The number of mappings.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_virtual_dsetname(System.Int64, System.IntPtr, StringBuilder, System.IntPtr)

Gets the name of a source dataset used in the mapping. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pget_virtual_dsetname.htm

Declaration

public static System.IntPtr get_virtual_dsetname(System.Int64 dcpl_id, System.IntPtr index, StringBuilder name, System.IntPtr size)

Parameters

Type	Name	Description
System.Int64	dcpl_id	The identifier of the virtual dataset creation property list.
System.IntPtr	index	Mapping index.
StringBuilder	name	A buffer containing the name of the source dataset.
System.IntPtr	size	The size, in bytes, of the name buffer.

Returns

Type	Description
System.IntPtr	Returns the length of the dataset name if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

get_virtual_dsetname(System.Int64, System.IntPtr, Byte[], System.IntPtr)

Gets the name of a source dataset used in the mapping. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pget_virtual_dsetname.htm

Declaration

public static System.IntPtr get_virtual_dsetname(System.Int64 dcpl_id, System.IntPtr index, byte[] name, System.IntPtr size)

Parameters

Type	Name	Description
System.Int64	dcpl_id	The identifier of the virtual dataset creation property list.
System.IntPtr	index	Mapping index.
System.Byte[]	name	A buffer containing the name of the source dataset.
System.IntPtr	size	The size, in bytes, of the name buffer.

Returns

Type	Description
System.IntPtr	Returns the length of the dataset name if successful; otherwise returns a negative value.

get_virtual_filename(System.Int64, System.IntPtr, StringBuilder, System.IntPtr)

Gets the filename of a source dataset used in the mapping. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pget_virtual_filename.htm

Declaration

public static System.IntPtr get_virtual_filename(System.Int64 dcpl_id, System.IntPtr index, StringBuilder name, System.IntPtr size)

Parameters

Type	Name	Description
System.Int64	dcpl_id	The identifier of the virtual dataset creation property list.
System.IntPtr	index	Mapping index.
StringBuilder	name	A buffer containing the name of the file containing the source dataset.
System.IntPtr	size	The size, in bytes, of the name buffer.

Returns

Type	Description
System.IntPtr	Returns the length of the dataset name if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

get_virtual_prefix(System.Int64, StringBuilder, System.IntPtr)

Retrieves prefix applied to VDS source file paths See https://portal.hdfgroup.org/display/HDF5/H5P_GET_VIRTUAL_PREFIX

Declaration

public static System.IntPtr get_virtual_prefix(System.Int64 dapl, StringBuilder prefix, System.IntPtr size)

Parameters

Type	Name	Description
System.Int64	dapl	Dataset access property list identifier.
StringBuilder	prefix	Prefix applied to VDS source file paths.
System.IntPtr	size	Size of prefix buffer (including null terminator) in bytes.

Returns

Type	Description
System.IntPtr	Returns the size of prefix and the prefix string will be stored in prefix if successful. Otherwise returns a negative value and the contents of prefix will be undefined.

get_virtual_printf_gap(System.Int64, ref System.UInt64)

Returns the maximum number of missing source files and/or datasets with the printf-style names when getting the extent for an unlimited virtual dataset. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pget_virtual_printf_gap.htm

Declaration

public static System.Int32 get_virtual_printf_gap(System.Int64 plist_id, ref System.UInt64 gap_size)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset access property list identifier for the virtual dataset
System.UInt64	gap_size	Maximum number of the files and/or datasets allowed to be missing for determining the extent of an unlimited virtual dataset with printf-style mappings.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_virtual_srcspace(System.Int64, System.IntPtr)

Gets a dataspace identifier for the selection within the source dataset used in the mapping. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pget_virtual_srcspace.htm

Declaration

public static System.Int64 get_virtual_srcspace(System.Int64 dcpl_id, System.IntPtr index)

Parameters

Type	Name	Description
System.Int64	dcpl_id	The identifier of the virtual dataset creation property list.
System.IntPtr	index	Mapping index.

Returns

Type	Description
System.Int64	Returns a valid dataspace identifier if successful; otherwise returns a negative value.

get_virtual_view(System.Int64, ref H5D.vds_view_t)

Retrieves the view of a virtual dataset accessed with dapl_id. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pget_virtual_view.htm

Declaration

public static System.Int32 get_virtual_view(System.Int64 dapl_id, ref H5D.vds_view_t view)

Parameters

Type	Name	Description
System.Int64	dapl_id	Dataset access property list identifier for the virtual dataset
H5D.vds_view_t	view	The flag specifying the view of the virtual dataset.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_virtual_vspace(System.Int64, System.IntPtr)

Gets a dataspace identifier for the selection within the virtual dataset used in the mapping. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pget_virtual_vspace.htm

Declaration

public static System.Int64 get_virtual_vspace(System.Int64 dcpl_id, System.IntPtr index)

Parameters

Type	Name	Description
System.Int64	dcpl_id	The identifier of the virtual dataset creation property list.
System.IntPtr	index	Mapping index.

Returns

Type	Description
System.Int64	Returns a valid dataspace identifier if successful; otherwise returns a negative value.

get_vlen_mem_manager(System.Int64, ref H5MM.allocate_t, ref IntPtr, ref H5MM.free_t, ref IntPtr)

Gets the memory manager for variable-length datatype allocation in

H5D.read

and

H5D.vlen_reclaim

.

Declaration

public static System.Int32 get_vlen_mem_manager(System.Int64 plist, ref H5MM.allocate_t alloc, ref IntPtr alloc_info, ref H5MM.free_t free, ref IntPtr free_info)

Parameters

Type	Name	Description
System.Int64	plist	Identifier for the dataset transfer property list.
H5MM.allocate_t	alloc	User’s allocate routine, or NULL for system malloc .
IntPtr	alloc_info	Extra parameter for user’s allocation routine. Contents are ignored if preceding parameter is NULL .
H5MM.free_t	free	User’s free routine, or NULL for system free .
IntPtr	free_info	Extra parameter for user’s free routine. Contents are ignored if preceding parameter is NULL .

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

H5Pfill_value_defined(System.Int64, ref H5D.fill_value_t)

Determines whether fill value is defined. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-FillValueDefined

Declaration

public static System.Int32 H5Pfill_value_defined(System.Int64 plist_id, ref H5D.fill_value_t status)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset creation property list identifier.
H5D.fill_value_t	status	Status of fill value in property list.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

insert(System.Int64, String, System.IntPtr, IntPtr, H5P.prp_cb2_t, H5P.prp_cb2_t, H5P.prp_cb2_t, H5P.prp_cb1_t, H5P.prp_compare_func_t, H5P.prp_cb1_t)

Registers a temporary property with a property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Insert2

Declaration

public static System.Int32 insert(System.Int64 plid, string name, System.IntPtr size, IntPtr value, H5P.prp_cb2_t set, H5P.prp_cb2_t get, H5P.prp_cb2_t delete, H5P.prp_cb1_t copy, H5P.prp_compare_func_t compare, H5P.prp_cb1_t close)

Parameters

Type	Name	Description
System.Int64	plid	Property list identifier to create temporary property within
System.String	name	Name of property to create
System.IntPtr	size	Size of property in bytes
IntPtr	value	Initial value for the property
H5P.prp_cb2_t	set	Callback routine called before a new value is copied into the property's value
H5P.prp_cb2_t	get	Callback routine called when a property value is retrieved from the property
H5P.prp_cb2_t	delete	Callback routine called when a property is deleted from a property list
H5P.prp_cb1_t	copy	Callback routine called when a property is copied from an existing property list
H5P.prp_compare_func_t	compare	Callback routine called when a property is compared with another property list
H5P.prp_cb1_t	close	Callback routine called when a property list is being closed and the property value will be disposed of

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

isa_class(System.Int64, System.Int64)

Determines whether a property list is a member of a class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-IsAClass

Declaration

public static System.Int32 isa_class(System.Int64 plist, System.Int64 pclass)

Parameters

Type	Name	Description
System.Int64	plist	Property list identifier
System.Int64	pclass	Property list class identifier

Returns

Type	Description
System.Int32	Returns a positive value if true or zero if false; returns a negative value on failure.

iterate(System.Int64, ref Int32, H5P.iterate_t, IntPtr)

Iterates over properties in a property class or list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Iterate

Declaration

public static int iterate(System.Int64 id, ref int idx, H5P.iterate_t iter_func, IntPtr iter_data)

Parameters

Type	Name	Description
System.Int64	id	Identifier of property object to iterate over
System.Int32	idx	Index of the property to begin with
H5P.iterate_t	iter_func	Function pointer to function to be called with each property iterated over
IntPtr	iter_data	Pointer to iteration data from user

Returns

Type	Description
System.Int32	Returns the value of the last call to iter_func if it was non-zero; zero if all properties have been processed. Returns a negative value on failure.

modify_filter(System.Int64, H5Z.filter_t, UInt32, System.IntPtr, UInt32[])

Modifies a filter in the filter pipeline. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-ModifyFilter

Declaration

public static System.Int32 modify_filter(System.Int64 plist_id, H5Z.filter_t filter_id, uint flags, System.IntPtr cd_nelmts, uint[] cd_values)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset or group creation property list identifier
H5Z.filter_t	filter_id	Filter to be modified.
System.UInt32	flags	Bit vector specifying certain general properties of the filter.
System.IntPtr	cd_nelmts	Number of elements in cd_values .
System.UInt32[]	cd_values	Auxiliary data for the filter.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

register(System.Int64, String, System.IntPtr, IntPtr, H5P.prp_cb1_t, H5P.prp_cb2_t, H5P.prp_cb2_t, H5P.prp_cb2_t, H5P.prp_cb1_t, H5P.prp_compare_func_t, H5P.prp_cb1_t)

Registers a permanent property with a property list class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Register2

Declaration

public static System.Int32 register(System.Int64 cls, string name, System.IntPtr size, IntPtr default_value, H5P.prp_cb1_t create, H5P.prp_cb2_t set, H5P.prp_cb2_t get, H5P.prp_cb2_t delete, H5P.prp_cb1_t copy, H5P.prp_compare_func_t compare, H5P.prp_cb1_t close)

Parameters

Type	Name	Description
System.Int64	cls	Property list class to register permanent property within
System.String	name	Name of property to register
System.IntPtr	size	Size of property in bytes
IntPtr	default_value	Default value for property in newly created property lists
H5P.prp_cb1_t	create	Callback routine called when a property list is being created and the property value will be initialized
H5P.prp_cb2_t	set	Callback routine called before a new value is copied into the property's value
H5P.prp_cb2_t	get	Callback routine called when a property value is retrieved from the property
H5P.prp_cb2_t	delete	Callback routine called when a property is deleted from a property list
H5P.prp_cb1_t	copy	Callback routine called when a property is copied from a property list
H5P.prp_compare_func_t	compare	Callback routine called when a property is compared with another property list
H5P.prp_cb1_t	close	Callback routine called when a property list is being closed and the property value will be disposed of

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

remove(System.Int64, String)

Removes a property from a property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Remove

Declaration

public static System.Int32 remove(System.Int64 plid, string name)

Parameters

Type	Name	Description
System.Int64	plid	Identifier of the property list to modify
System.String	name	Name of property to remove

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

remove_filter(System.Int64, H5Z.filter_t)

Delete one or more filters in the filter pipeline. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-RemoveFilter

Declaration

public static System.Int32 remove_filter(System.Int64 plist_id, H5Z.filter_t filter)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset or group creation property list identifier.
H5Z.filter_t	filter	Filter to be deleted.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set(System.Int64, String, IntPtr)

Sets a property list value. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Set

Declaration

public static System.Int32 set(System.Int64 plid, string name, IntPtr value)

Parameters

Type	Name	Description
System.Int64	plid	Property list identifier to modify
System.String	name	Name of property to modify
IntPtr	value	Pointer to value to set the property to

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

set_alignment(System.Int64, System.UInt64, System.UInt64)

Sets alignment properties of a file access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetAlignment

Declaration

public static System.Int32 set_alignment(System.Int64 plist, System.UInt64 threshold, System.UInt64 alignment)

Parameters

Type	Name	Description
System.Int64	plist	Identifier for a file access property list.
System.UInt64	threshold	Threshold value.
System.UInt64	alignment	Alignment value.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_alloc_time(System.Int64, H5D.alloc_time_t)

Sets the timing for storage space allocation. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetAllocTime

Declaration

public static System.Int32 set_alloc_time(System.Int64 plist_id, H5D.alloc_time_t alloc_time)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset creation property list identifier.
H5D.alloc_time_t	alloc_time	When to allocate dataset storage space.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_append_flush(System.Int64, UInt32, System.UInt64[], H5D.append_cb_t, IntPtr)

Sets two actions to perform when the size of a dataset’s dimension being appended reaches a specified boundary. See https://www.hdfgroup.org/HDF5/docNewFeatures/SWMR/H5Pset_append_flush.htm

Declaration

public static System.Int32 set_append_flush(System.Int64 dapl_id, uint ndims, System.UInt64[] boundary, H5D.append_cb_t func, IntPtr udata)

Parameters

Type	Name	Description
System.Int64	dapl_id	Dataset access property list identifier.
System.UInt32	ndims	The number of elements for boundary.
System.UInt64[]	boundary	The dimension sizes used to determine the boundary.
H5D.append_cb_t	func	The user-defined callback function.
IntPtr	udata	The user-defined input data.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_attr_creation_order(System.Int64, UInt32)

Sets tracking and indexing of attribute creation order. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetAttrCreationOrder

Declaration

public static System.Int32 set_attr_creation_order(System.Int64 ocpl_id, uint crt_order_flags)

Parameters

Type	Name	Description
System.Int64	ocpl_id	Object creation property list identifier
System.UInt32	crt_order_flags	Flags specifying whether to track and index attribute creation order

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_attr_phase_change(System.Int64, UInt32, UInt32)

Sets attribute storage phase change thresholds. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetAttrPhaseChange

Declaration

public static System.Int32 set_attr_phase_change(System.Int64 ocpl_id, uint max_compact = null, uint min_dense = null)

Parameters

Type	Name	Description
System.Int64	ocpl_id	Object creation property list identifier
System.UInt32	max_compact	Maximum number of attributes to be stored in compact storage
System.UInt32	min_dense	Minimum number of attributes to be stored in dense storage

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_btree_ratios(System.Int64, Double, Double, Double)

Sets B-tree split ratios for a dataset transfer property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetBTreeRatios

Declaration

public static System.Int32 set_btree_ratios(System.Int64 plist, double left, double middle, double right)

Parameters

Type	Name	Description
System.Int64	plist	The dataset transfer property list identifier.
System.Double	left	The B-tree split ratio for left-most nodes.
System.Double	middle	The B-tree split ratio for right-most nodes and lone nodes.
System.Double	right	The B-tree split ratio for all other nodes.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_buffer(System.Int64, System.UInt64, IntPtr, IntPtr)

Sets type conversion and background buffers. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetBuffer

Declaration

public static System.Int32 set_buffer(System.Int64 plist, System.UInt64 size, IntPtr tconv, IntPtr bkg)

Parameters

Type	Name	Description
System.Int64	plist	Identifier for the dataset transfer property list.
System.UInt64	size	Size, in bytes, of the type conversion and background buffers.
IntPtr	tconv	Pointer to application-allocated type conversion buffer.
IntPtr	bkg	Pointer to application-allocated background buffer.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_cache(System.Int64, Int32, System.IntPtr, System.IntPtr, Double)

Sets the raw data chunk cache parameters. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetCache

Declaration

public static System.Int32 set_cache(System.Int64 plist_id, int mdc_nelmts, System.IntPtr rdcc_nslots, System.IntPtr rdcc_nbytes, double rdcc_w0)

Parameters

Type	Name	Description
System.Int64	plist_id	File access property list identifier.
System.Int32	mdc_nelmts	UNSUSED
System.IntPtr	rdcc_nslots	The number of chunk slots in the raw data chunk cache for this dataset.
System.IntPtr	rdcc_nbytes	Total size of the raw data chunk cache in bytes.
System.Double	rdcc_w0	The chunk preemption policy for all datasets.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_char_encoding(System.Int64, H5T.cset_t)

Sets the character encoding used to encode link and attribute names. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetCharEncoding

Declaration

public static System.Int32 set_char_encoding(System.Int64 plist_id, H5T.cset_t encoding)

Parameters

Type	Name	Description
System.Int64	plist_id	Link creation or attribute creation property list identifier
H5T.cset_t	encoding	String encoding character set

Returns

Type	Description
System.Int32	Returns a non-negative valule if successful; otherwise returns a negative value.

set_chunk(System.Int64, Int32, System.UInt64*)

Sets the size of the chunks used to store a chunked layout dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetChunk

Declaration

public static System.Int32 set_chunk(System.Int64 plist_id, int ndims, System.UInt64*dims)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset creation property list identifier.
System.Int32	ndims	The number of dimensions of each chunk.
System.UInt64*	dims	An array defining the size, in dataset elements, of each chunk.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_chunk(System.Int64, Int32, System.UInt64[])

Sets the size of the chunks used to store a chunked layout dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetChunk

Declaration

public static System.Int32 set_chunk(System.Int64 plist_id, int ndims, System.UInt64[] dims)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset creation property list identifier.
System.Int32	ndims	The number of dimensions of each chunk.
System.UInt64[]	dims	An array defining the size, in dataset elements, of each chunk.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_chunk_cache(System.Int64, System.IntPtr, System.IntPtr, Double)

Sets the raw data chunk cache parameters. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetChunkCache

Declaration

public static System.Int32 set_chunk_cache(System.Int64 dapl_id, System.IntPtr rdcc_nslots, System.IntPtr rdcc_nbytes, double rdcc_w0)

Parameters

Type	Name	Description
System.Int64	dapl_id	Dataset access property list identifier.
System.IntPtr	rdcc_nslots	The number of chunk slots in the raw data chunk cache for this dataset.
System.IntPtr	rdcc_nbytes	The total size of the raw data chunk cache for this dataset.
System.Double	rdcc_w0	The chunk preemption policy for this dataset.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_chunk_opts(System.Int64, UInt32)

Sets the edge chunk option in a dataset creation property list. See https://www.hdfgroup.org/HDF5/docNewFeatures/PartialEdgeChunks/H5Pset_chunk_opts.htm

Declaration

public static System.Int32 set_chunk_opts(System.Int64 dcpl_id, uint opts)

Parameters

Type	Name	Description
System.Int64	dcpl_id	Dataset creation property list identifier.
System.UInt32	opts	Edge chunk option flag.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_copy_object(System.Int64, UInt32)

Sets properties to be used when an object is copied. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetCopyObject

Declaration

public static System.Int32 set_copy_object(System.Int64 ocpypl_id, uint copy_options)

Parameters

Type	Name	Description
System.Int64	ocpypl_id	Object copy property list identifier
System.UInt32	copy_options	Copy option(s) to be set

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_core_write_tracking(System.Int64, System.UInt32, System.IntPtr)

Sets write tracking information for core driver,

H5FD_CORE

.

Declaration

public static System.Int32 set_core_write_tracking(System.Int64 fapl_id, System.UInt32 is_enabled, System.IntPtr page_size)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
System.UInt32	is_enabled	Boolean value specifying whether feature is enabled.
System.IntPtr	page_size	Positive integer specifying size, in bytes, of write aggregation pages.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful. Otherwise returns a negative value.

set_create_intermediate_group(System.Int64, UInt32)

Specifies in property list whether to create missing intermediate groups. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetCreateIntermediateGroup

Declaration

public static System.Int32 set_create_intermediate_group(System.Int64 lcpl_id, uint crt_intermed_group)

Parameters

Type	Name	Description
System.Int64	lcpl_id	Link creation property list identifier
System.UInt32	crt_intermed_group	Flag specifying whether to create intermediate groups upon the creation of an object

Returns

Type	Description
System.Int32	Returns a non-negative valule if successful; otherwise returns a negative value.

set_data_transform(System.Int64, String)

Sets a data transform expression.

Declaration

public static System.Int32 set_data_transform(System.Int64 plist_id, string expression)

Parameters

Type	Name	Description
System.Int64	plist_id	Identifier of the property list or class
System.String	expression	Pointer to the null-terminated data transform expression

Returns

Type	Description
System.Int32	Returns a non-negative valule if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

set_deflate(System.Int64, UInt32)

Sets deflate (GNU gzip) compression method and compression level. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetDeflate

Declaration

public static System.Int32 set_deflate(System.Int64 plist_id, uint level)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset or group creation property list identifier.
System.UInt32	level	Compression level.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_driver(System.Int64, System.Int64, IntPtr)

Sets a file driver. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetDriver

Declaration

public static System.Int32 set_driver(System.Int64 plist_id, System.Int64 new_driver_id, IntPtr new_driver_info)

Parameters

Type	Name	Description
System.Int64	plist_id	File access or data transfer property list identifier.
System.Int64	new_driver_id	Driver identifier.
IntPtr	new_driver_info	Optional struct containing driver properties.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful. Otherwise returns a negative value.

set_dset_no_attrs_hint(System.Int64, System.UInt32)

Sets the flag to create minimized dataset object headers. See https://portal.hdfgroup.org/display/HDF5/H5P_SET_DSET_NO_ATTRS_HINT

Declaration

public static System.Int32 set_dset_no_attrs_hint(System.Int64 plist_id, System.UInt32 minimize)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset creation property list identifier
System.UInt32	minimize	Flag indicating whether the library will or will not create minimized dataset object headers

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_edc_check(System.Int64, H5Z.EDC_t)

Sets whether to enable error-detection when reading a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetEdcCheck

Declaration

public static System.Int32 set_edc_check(System.Int64 plist, H5Z.EDC_t check)

Parameters

Type	Name	Description
System.Int64	plist	Dataset transfer property list identifier.
H5Z.EDC_t	check	Specifies whether error checking is enabled or disabled for dataset read operations.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_efile_prefix(System.Int64, String)

Sets the external dataset storage file prefix in the dataset access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetEfilePrefix

Declaration

public static System.Int32 set_efile_prefix(System.Int64 dapl, string prefix)

Parameters

Type	Name	Description
System.Int64	dapl	Dataset access property list identifier.
System.String	prefix	Dataset external storage prefix.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

set_elink_acc_flags(System.Int64, UInt32)

Sets the external link traversal file access flag in a link access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetELinkAccFlags

Declaration

public static System.Int32 set_elink_acc_flags(System.Int64 lapl_id, uint flags)

Parameters

Type	Name	Description
System.Int64	lapl_id	Link access property list identifier
System.UInt32	flags	The access flag for external link traversal.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_elink_cb(System.Int64, H5L.elink_traverse_t, IntPtr)

Sets the external link traversal callback function in a link access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetELinkCb

Declaration

public static System.Int32 set_elink_cb(System.Int64 lapl_id, H5L.elink_traverse_t func, IntPtr op_data)

Parameters

Type	Name	Description
System.Int64	lapl_id	Link access property list identifier.
H5L.elink_traverse_t	func	User-defined external link traversal callback function.
IntPtr	op_data	User-defined input data for the callback function.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_elink_fapl(System.Int64, System.Int64)

Sets a file access property list for use in accessing a file pointed to by an external link. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetELinkFapl

Declaration

public static System.Int32 set_elink_fapl(System.Int64 lapl_id, System.Int64 fapl_id)

Parameters

Type	Name	Description
System.Int64	lapl_id	Link access property list identifier
System.Int64	fapl_id	File access property list identifier

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_elink_file_cache_size(System.Int64, UInt32)

Sets the number of files that can be held open in an external link open file cache. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetELinkFileCacheSize

Declaration

public static System.Int32 set_elink_file_cache_size(System.Int64 fapl_id, uint efc_size)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier
System.UInt32	efc_size	External link open file cache size in number of files.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_elink_prefix(System.Int64, String)

Sets prefix to be applied to external link paths. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetELinkPrefix

Declaration

public static System.Int32 set_elink_prefix(System.Int64 lapl_id, string prefix)

Parameters

Type	Name	Description
System.Int64	lapl_id	Link access property list identifier
System.String	prefix	Prefix to be applied to external link paths

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

set_est_link_info(System.Int64, UInt32, UInt32)

Sets estimated number of links and length of link names in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetEstLinkInfo

Declaration

public static System.Int32 set_est_link_info(System.Int64 gcpl_id, uint est_num_entries, uint est_name_len)

Parameters

Type	Name	Description
System.Int64	gcpl_id	Group creation property list identifier
System.UInt32	est_num_entries	Estimated number of links to be inserted into group
System.UInt32	est_name_len	Estimated average length of link names

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_evict_on_close(System.Int64, System.UInt32)

Controls the library's behavior of evicting metadata associated with a closed object. See https://support.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetEvictOnClose

Declaration

public static System.Int32 set_evict_on_close(System.Int64 plist, System.UInt32 evict_on_close)

Parameters

Type	Name	Description
System.Int64	plist	Identifier of a file access property list.
System.UInt32	evict_on_close	Boolean flag, whether the HDF5 object should be evicted on close.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_external(System.Int64, String, System.IntPtr, System.UInt64)

Adds an external file to the list of external files. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetExternal

Declaration

public static System.Int32 set_external(System.Int64 plist, string name, System.IntPtr offset, System.UInt64 size)

Parameters

Type	Name	Description
System.Int64	plist	Identifier of a dataset creation property list.
System.String	name	Name of an external file.
System.IntPtr	offset	Offset, in bytes, from the beginning of the file to the location in the file where the data starts.
System.UInt64	size	Number of bytes reserved in the file for the data.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

set_family_offset(System.Int64, System.UInt64)

Sets offset property for low-level access to a file in a family of files.

Declaration

public static System.Int32 set_family_offset(System.Int64 fapl_id, System.UInt64 offset)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
System.UInt64	offset	Offset in bytes within the HDF5 file.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_fapl_core(System.Int64, IntPtr, System.UInt32)

Modifies the file access property list to use the

H5FD_CORE

driver.

Declaration

public static System.Int32 set_fapl_core(System.Int64 fapl, IntPtr increment, System.UInt32 backing_store)

Parameters

Type	Name	Description
System.Int64	fapl	File access property list identifier.
IntPtr	increment	Size, in bytes, of memory increments.
System.UInt32	backing_store	Boolean flag indicating whether to write the file contents to disk when the file is closed.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful. Otherwise returns a negative value.

set_fapl_direct(System.Int64, System.IntPtr, System.IntPtr, System.IntPtr)

Sets up use of the direct I/O driver. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFaplDirect

Declaration

public static System.Int32 set_fapl_direct(System.Int64 fapl_id, System.IntPtr alignment, System.IntPtr block_size, System.IntPtr cbuf_size)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier
System.IntPtr	alignment	Required memory alignment boundary
System.IntPtr	block_size	File system block size
System.IntPtr	cbuf_size	Copy buffer size

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_fapl_family(System.Int64, System.UInt64, System.Int64)

Sets the file access property list to use the family driver. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFaplFamily

Declaration

public static System.Int32 set_fapl_family(System.Int64 fapl_id, System.UInt64 memb_size, System.Int64 memb_fapl_id)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
System.UInt64	memb_size	Size in bytes of each file member.
System.Int64	memb_fapl_id	Identifier of file access property list for each family member.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_fapl_log(System.Int64, String, UInt64, System.IntPtr)

Sets up the logging virtual file driver (

H5FD_LOG

) for use. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFaplLog

Declaration

public static System.Int32 set_fapl_log(System.Int64 fapl_id, string logfile, UInt64 flags, System.IntPtr buf_size)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
System.String	logfile	Name of the log file.
UInt64	flags	Flags specifying the types of logging activity.
System.IntPtr	buf_size	The size of the logging buffers, in bytes.

Returns

Type	Description
System.Int32	Returns non-negative if successful. Otherwise returns negative.

Remarks

ASCII strings ONLY!

set_fapl_sec2(System.Int64)

Modifies the file access property list to use the

H5FD_SEC2

driver.

See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFaplSec2

Declaration

public static System.Int32 set_fapl_sec2(System.Int64 fapl_id)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful. Otherwise returns a negative value.

set_fapl_split(System.Int64, String, System.Int64, String, System.Int64)

Emulates the old split file driver. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFaplSplit

Declaration

public static System.Int32 set_fapl_split(System.Int64 fapl_id, string meta_ext, System.Int64 meta_plist_id, string raw_ext, System.Int64 raw_plist_id)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
System.String	meta_ext	Metadata filename extension.
System.Int64	meta_plist_id	File access property list identifier for the metadata file.
System.String	raw_ext	Raw data filename extension.
System.Int64	raw_plist_id	File access property list identifier for the raw data file.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful. Otherwise returns a negative value.

Remarks

ASCII strings ONLY!

set_fapl_stdio(System.Int64)

Sets the standard I/O driver. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFaplStdio

Declaration

public static System.Int32 set_fapl_stdio(System.Int64 fapl_id)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful. Otherwise returns a negative value.

set_fapl_windows(System.Int64)

Sets the Windows I/O driver. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFaplWindows

Declaration

public static System.Int32 set_fapl_windows(System.Int64 fapl_id)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_fclose_degree(System.Int64, H5F.close_degree_t)

Sets the file close degree. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFcloseDegree

Declaration

public static System.Int32 set_fclose_degree(System.Int64 fapl_id, H5F.close_degree_t fc_degree)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
H5F.close_degree_t	fc_degree	The file close degree property.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful. Otherwise returns a negative value.

set_file_image(System.Int64, IntPtr, System.IntPtr)

Sets an initial file image in a memory buffer. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFileImage

Declaration

public static System.Int32 set_file_image(System.Int64 fapl_id, IntPtr buf_ptr, System.IntPtr buf_len)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier
IntPtr	buf_ptr	Pointer to the initial file image, or NULL if no initial file image is desired
System.IntPtr	buf_len	Size of the supplied buffer, or 0 (zero) if no initial image is desired

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_file_image_callbacks(System.Int64, ref H5FD.file_image_callbacks_t)

Sets the callbacks for working with file images. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFileImageCallbacks

Declaration

public static System.Int32 set_file_image_callbacks(System.Int64 fapl_id, ref H5FD.file_image_callbacks_t callbacks_ptr)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier
H5FD.file_image_callbacks_t	callbacks_ptr	Pointer to an instance of the H5FD.file_image_callbacks_t structure.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_file_space(System.Int64, H5F.file_space_type_t, System.UInt64)

Sets the file space management strategy and/or free-space section threshold for an HDF5 file. See https://www.hdfgroup.org/HDF5/docNewFeatures/FileSpace/H5Pset_file_space.htm

Declaration

public static System.Int32 set_file_space(System.Int64 fcpl, H5F.file_space_type_t strategy, System.UInt64 threshold = null)

Parameters

Type	Name	Description
System.Int64	fcpl	The file creation property list identifier.
H5F.file_space_type_t	strategy	The strategy for file space management.
System.UInt64	threshold	The free-space section threshold. The library default is 1, which is to track all free-space sections.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_file_space_page_size(System.Int64, System.UInt64)

Sets the file space page size for a file creation property list. See https://support.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFileSpacePageSize

Declaration

public static System.Int32 set_file_space_page_size(System.Int64 fcpl, System.UInt64 fsp_size)

Parameters

Type	Name	Description
System.Int64	fcpl	The file creation property list identifier.
System.UInt64	fsp_size	File space page size

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_file_space_strategy(System.Int64, H5F.fspace_strategy_t, System.UInt32, System.UInt64)

Sets the file space handling strategy and persisting free-space values for a file creation property list. See https://support.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFileSpaceStrategy

Declaration

public static System.Int32 set_file_space_strategy(System.Int64 fcpl, H5F.fspace_strategy_t strategy, System.UInt32 persist, System.UInt64 threshold)

Parameters

Type	Name	Description
System.Int64	fcpl	The file creation property list identifier.
H5F.fspace_strategy_t	strategy	The file space handling strategy to be used.
System.UInt32	persist	A boolean value to indicate whether free space should be persistent or not.
System.UInt64	threshold	The smallest free-space section size that the free space manager will track.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_fill_time(System.Int64, H5D.fill_time_t)

Sets the time when fill values are written to a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFillTime

Declaration

public static System.Int32 set_fill_time(System.Int64 plist_id, H5D.fill_time_t fill_time)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset creation property list identifier.
H5D.fill_time_t	fill_time	When to write fill values to a dataset.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_fill_value(System.Int64, System.Int64, IntPtr)

Sets the fill value for a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFillValue

Declaration

public static System.Int32 set_fill_value(System.Int64 plist_id, System.Int64 type_id, IntPtr value)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset creation property list identifier.
System.Int64	type_id	Datatype of value.
IntPtr	value	Pointer to buffer containing value to use as fill value.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_filter(System.Int64, H5Z.filter_t, UInt32, System.IntPtr, UInt32[])

Adds a filter to the filter pipeline. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFilter

Declaration

public static System.Int32 set_filter(System.Int64 plist_id, H5Z.filter_t filter_id, uint flags, System.IntPtr cd_nelmts, uint[] cd_values)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset or group creation property list identifier.
H5Z.filter_t	filter_id	Filter identifier for the filter to be added to the pipeline.
System.UInt32	flags	Bit vector specifying certain general properties of the filter.
System.IntPtr	cd_nelmts	Number of elements in cd_values .
System.UInt32[]	cd_values	Auxiliary data for the filter.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_filter_callback(System.Int64, H5Z.filter_func_t, IntPtr)

Sets user-defined filter callback function. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFilterCallback

Declaration

public static System.Int32 set_filter_callback(System.Int64 plist, H5Z.filter_func_t func, IntPtr op_data)

Parameters

Type	Name	Description
System.Int64	plist	Dataset transfer property list identifier.
H5Z.filter_func_t	func	User-defined filter callback function.
IntPtr	op_data	User-defined input data for the callback function.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_fletcher32(System.Int64)

Sets up use of the Fletcher32 checksum filter. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFletcher32

Declaration

public static System.Int32 set_fletcher32(System.Int64 plist_id)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset or group creation property list identifier.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_gc_reference(System.Int64, UInt32)

Sets garbage collecting references flag.

Declaration

public static System.Int32 set_gc_reference(System.Int64 plist, uint gc_ref)

Parameters

Type	Name	Description
System.Int64	plist	File access property list identifier.
System.UInt32	gc_ref	Flag setting reference garbage collection to on (1) or off (0).

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_hyper_vector_size(System.Int64, System.IntPtr)

Sets number of I/O vectors to be read/written in hyperslab I/O. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetHyperVectorSize

Declaration

public static System.Int32 set_hyper_vector_size(System.Int64 dxpl_id, System.IntPtr vector_size)

Parameters

Type	Name	Description
System.Int64	dxpl_id	Dataset transfer property list identifier.
System.IntPtr	vector_size	Number of I/O vectors to accumulate in memory for I/O operations.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_istore_k(System.Int64, UInt32)

Sets the size of the parameter used to control the B-trees for indexing chunked datasets. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetIstoreK

Declaration

public static System.Int32 set_istore_k(System.Int64 fcpl_id, uint ik)

Parameters

Type	Name	Description
System.Int64	fcpl_id	File creation property list identifier
System.UInt32	ik	1/2 rank of chunked storage B-tree

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_layout(System.Int64, H5D.layout_t)

Sets the type of storage used to store the raw data for a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetLayout

Declaration

public static System.Int32 set_layout(System.Int64 plist, H5D.layout_t layout)

Parameters

Type	Name	Description
System.Int64	plist	Identifier of property list to query.
H5D.layout_t	layout	Type of storage layout for raw data.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_libver_bounds(System.Int64, H5F.libver_t, H5F.libver_t)

Sets bounds on library versions, and indirectly format versions, to be used when creating objects. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetLibverBounds

Declaration

public static System.Int32 set_libver_bounds(System.Int64 plist, H5F.libver_t low = default(H5F.libver_t), H5F.libver_t high = default(H5F.libver_t))

Parameters

Type	Name	Description
System.Int64	plist	File access property list identifier
H5F.libver_t	low	The earliest version of the library that will be used for writing objects, indirectly specifying the earliest object format version that can be used when creating objects in the file.
H5F.libver_t	high	The latest version of the library that will be used for writing objects, indirectly specifying the latest object format version that can be used when creating objects in the file.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_link_creation_order(System.Int64, UInt32)

Sets creation order tracking and indexing for links in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetLinkCreationOrder

Declaration

public static System.Int32 set_link_creation_order(System.Int64 gcpl_id, uint crt_order_flags)

Parameters

Type	Name	Description
System.Int64	gcpl_id	Group creation property list identifier
System.UInt32	crt_order_flags	Creation order flag(s)

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_link_phase_change(System.Int64, UInt32, UInt32)

Sets the parameters for conversion between compact and dense groups. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetLinkPhaseChange

Declaration

public static System.Int32 set_link_phase_change(System.Int64 gcpl_id, uint max_compact = null, uint min_dense = null)

Parameters

Type	Name	Description
System.Int64	gcpl_id	Group creation property list identifier
System.UInt32	max_compact	Maximum number of links for compact storage
System.UInt32	min_dense	Minimum number of links for dense storage

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_local_heap_size_hint(System.Int64, System.IntPtr)

Specifies the anticipated maximum size of a local heap. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetLocalHeapSizeHint

Declaration

public static System.Int32 set_local_heap_size_hint(System.Int64 gcpl_id, System.IntPtr size_hint)

Parameters

Type	Name	Description
System.Int64	gcpl_id	Group creation property list identifier
System.IntPtr	size_hint	Anticipated maximum size in bytes of local heap

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_mcdt_search_cb(System.Int64, H5O.mcdt_search_cb_t, IntPtr)

Sets the callback function that

H5Ocopy

will invoke before searching the entire destination file for a matching committed datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetMcdtSearchCb

Declaration

public static System.Int32 set_mcdt_search_cb(System.Int64 ocpypl_id, H5O.mcdt_search_cb_t func, IntPtr op_data)

Parameters

Type	Name	Description
System.Int64	ocpypl_id	Object copy property list identifier
H5O.mcdt_search_cb_t	func	User-defined callback function
IntPtr	op_data	User-defined input data for the callback function

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_mdc_config(System.Int64, IntPtr)

Set the initial metadata cache configuration in the indicated File Access Property List to the supplied value. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetMdcConfig

Declaration

public static System.Int32 set_mdc_config(System.Int64 plist_id, IntPtr config_ptr)

Parameters

Type	Name	Description
System.Int64	plist_id	Identifier of the file access property list.
IntPtr	config_ptr	Pointer to the instance of H5AC.cache_config_t containing the desired configuration.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_mdc_image_config(System.Int64, IntPtr)

Sets the metadata cache image option for a file access property list. See https://support.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetMDCImageConfig

Declaration

public static System.Int32 set_mdc_image_config(System.Int64 fapl_id, IntPtr config_ptr)

Parameters

Type	Name	Description
System.Int64	fapl_id	Identifier of the file access property list.
IntPtr	config_ptr	Pointer to the instance of H5AC.cache_image_config_t containing the desired configuration.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_mdc_log_options(System.Int64, System.UInt32, String, System.UInt32)

Sets metadata cache logging options. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Pset_mdc_log_options.htm

Declaration

public static System.Int32 set_mdc_log_options(System.Int64 fapl_id, System.UInt32 is_enabled, string location, System.UInt32 start_on_access)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
System.UInt32	is_enabled	Whether logging is enabled.
System.String	location	Log file name.
System.UInt32	start_on_access	Whether the logging will begin as soon as the file is opened or created.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful. Otherwise returns a negative value.

Remarks

ASCII strings ONLY!

set_meta_block_size(System.Int64, System.UInt64)

Sets the minimum metadata block size. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetMetaBlockSize

Declaration

public static System.Int32 set_meta_block_size(System.Int64 fapl_id, System.UInt64 size)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
System.UInt64	size	Minimum size, in bytes, of metadata block allocations.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful. Otherwise returns a negative value.

set_metadata_read_attempts(System.Int64, UInt32)

Retrieves the number of read attempts from a file access property list. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Pset_metadata_read_attempts.htm

Declaration

public static System.Int32 set_metadata_read_attempts(System.Int64 fapl, uint attempts)

Parameters

Type	Name	Description
System.Int64	fapl	Identifier for a file access property list.
System.UInt32	attempts	The number of read attempts.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_nbit(System.Int64)

Sets up the use of the N-Bit filter. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetNbit

Declaration

public static System.Int32 set_nbit(System.Int64 plist_id)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset creation property list identifier.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_nlinks(System.Int64, System.IntPtr)

Sets maximum number of soft or user-defined link traversals. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetNLinks

Declaration

public static System.Int32 set_nlinks(System.Int64 lapl_id, System.IntPtr nlinks)

Parameters

Type	Name	Description
System.Int64	lapl_id	File access property list identifier
System.IntPtr	nlinks	Maximum number of links to traverse

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_obj_track_times(System.Int64, System.UInt32)

Sets the recording of times associated with an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetObjTrackTimes

Declaration

public static System.Int32 set_obj_track_times(System.Int64 ocpl_id, System.UInt32 track_times)

Parameters

Type	Name	Description
System.Int64	ocpl_id	Object creation property list identifier
System.UInt32	track_times	Boolean value, 1 or 0, specifying whether object times are to be tracked

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_object_flush_cb(System.Int64, H5F.flush_cb_t, IntPtr)

Sets a callback function to invoke when an object flush occurs in the file. See https://www.hdfgroup.org/HDF5/docNewFeatures/SWMR/H5Pset_object_flush_cb.htm

Declaration

public static System.Int32 set_object_flush_cb(System.Int64 plist_id, H5F.flush_cb_t func, IntPtr udata)

Parameters

Type	Name	Description
System.Int64	plist_id	Identifier for a file access property list.
H5F.flush_cb_t	func	The user-defined callback function.
IntPtr	udata	The user-defined input data for the callback function.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_page_buffer_size(System.Int64, IntPtr, UInt32, UInt32)

Sets the maximum size for the page buffer and the minimum percentage for metadata and raw data pages. See https://support.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetPageBufferSize

Declaration

public static System.Int32 set_page_buffer_size(System.Int64 fapl_id, IntPtr buf_size, uint min_meta_perc, uint min_raw_perc)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier
IntPtr	buf_size	Maximum size, in bytes, of the page buffer
System.UInt32	min_meta_perc	Minimum metadata percentage to keep in the page buffer before allowing pages containing metadata to be evicted
System.UInt32	min_raw_perc	Minimum raw data percentage to keep in the page buffer before allowing pages containing raw data to be evicted

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_scaleoffset(System.Int64, H5Z.SO_scale_type_t, Int32)

Sets up the use of the scale-offset filter. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetScaleoffset

Declaration

public static System.Int32 set_scaleoffset(System.Int64 plist_id, H5Z.SO_scale_type_t scale_type, int scale_factor)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset creation property list identifier.
H5Z.SO_scale_type_t	scale_type	Flag indicating compression method.
System.Int32	scale_factor	Parameter related to scale. Must be non-negative.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_shared_mesg_index(System.Int64, UInt32, UInt32, UInt32)

Configures the specified shared object header message index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSharedMesgIndex

Declaration

public static System.Int32 set_shared_mesg_index(System.Int64 fcpl_id, uint index_num, uint mesg_type_flags, uint min_mesg_size)

Parameters

Type	Name	Description
System.Int64	fcpl_id	File creation property list identifier.
System.UInt32	index_num	Index being configured
System.UInt32	mesg_type_flags	Types of messages that should be stored in this index.
System.UInt32	min_mesg_size	Minimum message size.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_shared_mesg_nindexes(System.Int64, UInt32)

Sets number of shared object header message indexes. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSharedMesgNIndexes

Declaration

public static System.Int32 set_shared_mesg_nindexes(System.Int64 plist_id, uint nindexes)

Parameters

Type	Name	Description
System.Int64	plist_id	File creation property list
System.UInt32	nindexes	Number of shared object header message indexes to be available in files created with this property list

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_shared_mesg_phase_change(System.Int64, UInt32, UInt32)

Sets shared object header message storage phase change thresholds. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSharedMesgPhaseChange

Declaration

public static System.Int32 set_shared_mesg_phase_change(System.Int64 fcpl_id, uint max_list, uint min_btree)

Parameters

Type	Name	Description
System.Int64	fcpl_id	File creation property list identifier
System.UInt32	max_list	Threshold above which storage of a shared object header message index shifts from list to B-tree
System.UInt32	min_btree	Threshold below which storage of a shared object header message index reverts to list format

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_shuffle(System.Int64)

Sets up use of the shuffle filter. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetShuffle

Declaration

public static System.Int32 set_shuffle(System.Int64 plist_id)

Parameters

Type	Name	Description
System.Int64	plist_id	Dataset creation property list identifier.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_sieve_buf_size(System.Int64, System.IntPtr)

Sets the maximum size of the data sieve buffer. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSieveBufSize

Declaration

public static System.Int32 set_sieve_buf_size(System.Int64 fapl_id, System.IntPtr size)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
System.IntPtr	size	Maximum size, in bytes, of data sieve buffer.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful. Otherwise returns a negative value.

set_sizes(System.Int64, System.IntPtr, System.IntPtr)

Sets the byte size of the offsets and lengths used to address objects in an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSizes

Declaration

public static System.Int32 set_sizes(System.Int64 plist, System.IntPtr sizeof_addr, System.IntPtr sizeof_size)

Parameters

Type	Name	Description
System.Int64	plist	Identifier of property list to modify.
System.IntPtr	sizeof_addr	Size of an object offset in bytes.
System.IntPtr	sizeof_size	Size of an object length in bytes.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_small_data_block_size(System.Int64, System.UInt64)

Sets the size of a contiguous block reserved for small data. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSmallData

Declaration

public static System.Int32 set_small_data_block_size(System.Int64 fapl_id, System.UInt64 size = null)

Parameters

Type	Name	Description
System.Int64	fapl_id	File access property list identifier.
System.UInt64	size	Maximum size, in bytes, of the small data block.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise a negative value.

set_sym_k(System.Int64, UInt32, UInt32)

Sets the size of parameters used to control the symbol table nodes. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSymK

Declaration

public static System.Int32 set_sym_k(System.Int64 fcpl_id, uint ik, uint lk)

Parameters

Type	Name	Description
System.Int64	fcpl_id	File creation property list identifier
System.UInt32	ik	Symbol table tree rank
System.UInt32	lk	Symbol table node size

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_szip(System.Int64, UInt32, UInt32)

Sets up use of the SZIP compression filter. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSzip

Declaration

public static System.Int32 set_szip(System.Int64 plist, uint options_mask, uint pixels_per_block)

Parameters

Type	Name	Description
System.Int64	plist	Dataset creation property list identifier.
System.UInt32	options_mask	A bit-mask conveying the desired SZIP options.
System.UInt32	pixels_per_block	The number of pixels or data elements in each data block.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_type_conv_cb(System.Int64, H5T.conv_except_func_t, IntPtr)

Sets user-defined datatype conversion callback function. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetTypeConvCb

Declaration

public static System.Int32 set_type_conv_cb(System.Int64 plist, H5T.conv_except_func_t func, IntPtr op_data)

Parameters

Type	Name	Description
System.Int64	plist	Dataset transfer property list identifier.
H5T.conv_except_func_t	func	User-defined type conversion callback function.
IntPtr	op_data	User-defined input data for the callback function.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_userblock(System.Int64, System.UInt64)

Sets user block size. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetUserblock

Declaration

public static System.Int32 set_userblock(System.Int64 plist, System.UInt64 size)

Parameters

Type	Name	Description
System.Int64	plist	Identifier of property list to modify.
System.UInt64	size	Size of the user-block in bytes.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_virtual(System.Int64, System.Int64, String, String, System.Int64)

Sets the mapping between virtual and source datasets. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pset_virtual.htm

Declaration

public static System.Int32 set_virtual(System.Int64 dcpl_id, System.Int64 vspace_id, string src_file_name, string src_dset_name, System.Int64 src_space_id)

Parameters

Type	Name	Description
System.Int64	dcpl_id	The identifier of the dataset creation property list that will be used when creating the virtual dataset.
System.Int64	vspace_id	The dataspace identifier with the selection within the virtual dataset applied, possibly an unlimited selection.
System.String	src_file_name	The name of the HDF5 file where the source dataset is or will be located.
System.String	src_dset_name	The path to the HDF5 dataset in the file specified by src_file_name.
System.Int64	src_space_id	The source dataset’s dataspace identifier with a selection applied, possibly an unlimited selection

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_virtual_prefix(System.Int64, String)

Sets prefix to be applied to VDS source file paths. See https://portal.hdfgroup.org/display/HDF5/H5P_SET_VIRTUAL_PREFIX

Declaration

public static System.Int32 set_virtual_prefix(System.Int64 dapl, string prefix)

Parameters

Type	Name	Description
System.Int64	dapl	Dataset access property list identifier.
System.String	prefix	Prefix to be applied to VDS source file paths.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

set_virtual_printf_gap(System.Int64, System.UInt64)

Sets the maximum number of missing source files and/or datasets with the printf-style names when getting the extent of an unlimited virtual dataset. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pset_virtual_printf_gap.htm

Declaration

public static System.Int32 set_virtual_printf_gap(System.Int64 dapl_id, System.UInt64 gap_size)

Parameters

Type	Name	Description
System.Int64	dapl_id	Dataset access property list identifier for the virtual dataset
System.UInt64	gap_size	Maximum number of files and/or datasets allowed to be missing for determining the extent of an unlimited virtual dataset with printf-style mappings

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_virtual_view(System.Int64, H5D.vds_view_t)

Sets the view of the virtual dataset (VDS) to include or exclude missing mapped elements. See https://www.hdfgroup.org/HDF5/docNewFeatures/VDS/H5Pset_virtual_view.htm

Declaration

public static System.Int32 set_virtual_view(System.Int64 plist_id, H5D.vds_view_t view)

Parameters

Type	Name	Description
System.Int64	plist_id	Identifier of the virtual dataset access property list.
H5D.vds_view_t	view	Flag specifying the extent of the data to be included in the view.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_vlen_mem_manager(System.Int64, H5MM.allocate_t, IntPtr, H5MM.free_t, IntPtr)

Sets the memory manager for variable-length datatype allocation in

H5Dread

and

H5Dvlen_reclaim

.

See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetVLMemManager

Declaration

public static System.Int32 set_vlen_mem_manager(System.Int64 plist, H5MM.allocate_t alloc, IntPtr alloc_info, H5MM.free_t free, IntPtr free_info)

Parameters

Type	Name	Description
System.Int64	plist	Identifier for the dataset transfer property list.
H5MM.allocate_t	alloc	User's allocate routine, or NULL for system malloc .
IntPtr	alloc_info	Extra parameter for user's allocation routine. Contents are ignored if preceding parameter is NULL .
H5MM.free_t	free	User's free routine, or NULL for system free .
IntPtr	free_info	Extra parameter for user's free routine. Contents are ignored if preceding parameter is NULL .

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

unregister(System.Int64, String)

Removes a property from a property list class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-Unregister

Declaration

public static System.Int32 unregister(System.Int64 cls, string name)

Parameters

Type	Name	Description
System.Int64	cls	Property list class from which to remove permanent property
System.String	name	Name of property to remove

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.