Class H5F

Inheritance

System.Object

H5F

Namespace: HDF.PInvoke

Assembly: HDF.PInvoke.dll

Syntax

public sealed class H5F : object

Fields

| Improve this Doc View Source

ACC_CREAT

create non-existing files

Declaration

public const uint ACC_CREAT = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

ACC_DEFAULT

Value passed to H5P.set_elink_acc_flags to cause flags to be taken from the parent file.

Declaration

public const uint ACC_DEFAULT = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

ACC_EXCL

fail if file already exists

Declaration

public const uint ACC_EXCL = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

ACC_RDONLY

absence of rdwr => rd-only

Declaration

public const uint ACC_RDONLY = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

ACC_RDWR

open for read and write

Declaration

public const uint ACC_RDWR = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

ACC_SWMR_READ

indicate that this file is open for reading in a single-writer/multi-reader (SWMR) scenario. Note that the process(es) opening the file for SWMR reading must also open the file with the

RDONLY

flag.

Declaration

public const uint ACC_SWMR_READ = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

ACC_SWMR_WRITE

indicate that this file is open for writing in a single-writer/multi-reader (SWMR) scenario. Note that the process(es) opening the file for reading must open the file with

RDONLY

access, and use the special

SWMR_READ

access flag.

Declaration

public const uint ACC_SWMR_WRITE = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

ACC_TRUNC

overwrite existing files

Declaration

public const uint ACC_TRUNC = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

FAMILY_DEFAULT

Declaration

public System.UInt64 FAMILY_DEFAULT

Field Value

Type	Description
System.UInt64

| Improve this Doc View Source

H5F_UNLIMITED

Unlimited file size for H5P.set_external()

Declaration

public const System.UInt64 H5F_UNLIMITED = null

Field Value

Type	Description
System.UInt64

| Improve this Doc View Source

NUM_METADATA_READ_RETRY_TYPES

Declaration

public const int NUM_METADATA_READ_RETRY_TYPES = null

Field Value

Type	Description
System.Int32

| Improve this Doc View Source

OBJ_ALL

All objects: H5F_OBJ_FILE|H5F_OBJ_DATASET|H5F_OBJ_GROUP|H5F_OBJ_DATATYPE|H5F_OBJ_ATTR)

Declaration

public const uint OBJ_ALL = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

OBJ_ATTR

Attribute objects

Declaration

public const uint OBJ_ATTR = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

OBJ_DATASET

Dataset objects

Declaration

public const uint OBJ_DATASET = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

OBJ_DATATYPE

Named datatype objects

Declaration

public const uint OBJ_DATATYPE = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

OBJ_FILE

File objects

Declaration

public const uint OBJ_FILE = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

OBJ_GROUP

Group objects

Declaration

public const uint OBJ_GROUP = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

OBJ_LOCAL

All local objects: Restrict search to objects opened through current file ID (as opposed to objects opened through any file ID accessing this file)

Declaration

public const uint OBJ_LOCAL = null

Field Value

Type	Description
System.UInt32

Methods

clear_elink_file_cache(System.Int64)

Clears the external link open file cache. https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-ClearELinkFileCache

Declaration

public static System.Int32 clear_elink_file_cache(System.Int64 file_id)

Parameters

Type	Name	Description
System.Int64	file_id	File identifier

Returns

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

close(System.Int64)

Terminates access to an HDF5 file. https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-Close

Declaration

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

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of a file to which access is terminated.

Returns

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

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

Creates an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-CreateS

Declaration

public static System.Int64 create(string filename, uint flags, System.Int64 create_plist = null, System.Int64 access_plist = null)

Parameters

Type	Name	Description
System.String	filename	Name of the file to access.
System.UInt32	flags	File access flags (H5.ACC_*).
System.Int64	create_plist	File creation property list identifier.
System.Int64	access_plist	File access property list identifier.

Returns

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

Remarks

filename MUST be an ASCII string.

flush(System.Int64, H5F.scope_t)

Flushes all buffers associated with a file to disk. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-Flush

Declaration

public static System.Int32 flush(System.Int64 object_id, H5F.scope_t scope)

Parameters

Type	Name	Description
System.Int64	object_id	Identifier of object used to identify the file.
H5F.scope_t	scope	Specifies the scope of the flushing action.

Returns

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

format_convert_super(System.Int64)

Declaration

public static System.Int32 format_convert_super(System.Int64 fid)

Parameters

Type	Name	Description
System.Int64	fid

Returns

Type	Description
System.Int32

get_access_plist(System.Int64)

Returns a file access property list identifier. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetAccessPlist

Declaration

public static System.Int64 get_access_plist(System.Int64 file_id)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of file of which to get access property list

Returns

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

get_create_plist(System.Int64)

Returns a file creation property list identifier. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetCreatePlist

Declaration

public static System.Int64 get_create_plist(System.Int64 file_id)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of file of which to get creation property list

Returns

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

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/H5F_GET_DSET_NO_ATTRS_HINT

Declaration

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

Parameters

Type	Name	Description
System.Int64	file_id	File 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_file_image(System.Int64, IntPtr, IntPtr)

Retrieves a copy of the image of an existing, open file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetFileImage

Declaration

public static System.IntPtr get_file_image(System.Int64 file_id, IntPtr buf_ptr, IntPtr buf_len)

Parameters

Type	Name	Description
System.Int64	file_id	Target file identifier
IntPtr	buf_ptr	Pointer to the buffer into which the image of the HDF5 file is to be copied
IntPtr	buf_len	Size of the supplied buffer

Returns

Type	Description
System.IntPtr	If successful, returns the size in bytes of the buffer required to store the file image if successful; otherwise returns a negative value.

get_filesize(System.Int64, ref System.UInt64)

Returns the size of an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetFilesize

Declaration

public static System.Int32 get_filesize(System.Int64 file_id, ref System.UInt64 size)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of a currently-open HDF5 file
System.UInt64	size	Size of the file, in bytes.

Returns

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

get_free_sections(System.Int64, H5F.mem_t, System.IntPtr, H5F.sect_info_t[])

Retrieves free-space section information for a file. See https://www.hdfgroup.org/HDF5/docNewFeatures/FileSpace/H5Fget_free_sections.htm

Declaration

public static System.IntPtr get_free_sections(System.Int64 file_id, H5F.mem_t type, System.IntPtr nsects, H5F.sect_info_t[] sect_info)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of a currently-open HDF5 file
H5F.mem_t	type	The file memory allocation type.
System.IntPtr	nsects	The number of free-space sections.
H5F.sect_info_t[]	sect_info	Array of instances of `H5F.sect_info_t` in which the free-space section information is to be returned.

Returns

Type	Description
System.IntPtr

get_freespace(System.Int64)

Returns the amount of free space in a file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetFreespace

Declaration

public static System.Int64 get_freespace(System.Int64 file_id)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of a currently-open HDF5 file

Returns

Type	Description
System.Int64	Returns the amount of free space in the file if successful; otherwise returns a negative value.

get_info(System.Int64, ref H5F.info_t)

Returns global information for a file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetInfo

Declaration

public static System.Int32 get_info(System.Int64 obj_id, ref H5F.info_t bh_info)

Parameters

Type	Name	Description
System.Int64	obj_id	Object identifier for any object in the file.
H5F.info_t	bh_info	Struct containing global file information.

Returns

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

get_intent(System.Int64, ref UInt32)

Determines the read/write or read-only status of a file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetIntent

Declaration

public static System.Int32 get_intent(System.Int64 file_id, ref uint intent)

Parameters

Type	Name	Description
System.Int64	file_id	File identifier for a currently-open HDF5 file.
System.UInt32	intent	Intended access mode flag as originally passed with H5Fopen.

Returns

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

get_mdc_config(System.Int64, ref H5AC.cache_config_t)

Obtain current metadata cache configuration for target file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetMdcConfig

Declaration

public static System.Int32 get_mdc_config(System.Int64 file_id, ref H5AC.cache_config_t config_ptr)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of the target file
H5AC.cache_config_t	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_hit_rate(System.Int64, ref Double)

Obtain target file's metadata cache hit rate. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetMdcHitRate

Declaration

public static System.Int32 get_mdc_hit_rate(System.Int64 file_id, ref double hit_rate_ptr)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of the target file
System.Double	hit_rate_ptr	Pointer to the double in which the hit rate is returned.

Returns

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

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

Obtain information about a cache image if it exists. See https://support.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetMdcImageInfo

Declaration

public static System.Int32 get_mdc_image_info(System.Int64 file_id, ref System.UInt64 image_addr, ref System.UInt64 image_len)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of the target file.
System.UInt64	image_addr	Offset of the cache image if it exists, or `HADDR_UNDEF` if it does not.
System.UInt64	image_len	Length of the cache image if it exists, or 0 if it does not.

Returns

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

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

Gets the current metadata cache logging status. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Fget_mdc_logging_status.htm

Declaration

public static System.Int32 get_mdc_logging_status(System.Int64 file_id, ref System.UInt32 is_enabled, ref System.UInt32 is_currently_logging)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of an open HDF5 file.
System.UInt32	is_enabled	Whether logging is enabled.
System.UInt32	is_currently_logging	Whether events are currently being logged.

Returns

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

get_mdc_size(System.Int64, ref System.IntPtr, ref System.IntPtr, ref System.IntPtr, ref Int32)

Obtain current metadata cache size data for specified file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetMdcSize

Declaration

public static System.Int32 get_mdc_size(System.Int64 file_id, ref System.IntPtr max_size_ptr, ref System.IntPtr min_clean_size_ptr, ref System.IntPtr cur_size_ptr, ref int cur_num_entries_ptr)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of the target file
System.IntPtr	max_size_ptr	Pointer to the location in which the current cache maximum size is to be returned, or NULL if this datum is not desired.
System.IntPtr	min_clean_size_ptr	Pointer to the location in which the current cache minimum clean size is to be returned, or NULL if that datum is not desired.
System.IntPtr	cur_size_ptr	Pointer to the location in which the current cache size is to be returned, or NULL if that datum is not desired.
System.Int32	cur_num_entries_ptr	Pointer to the location in which the current number of entries in the cache is to be returned, or NULL if that datum is not desired.

Returns

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

get_metadata_read_retry_info(System.Int64, ref H5F.retry_info_t)

Retrieves the collection of read retries for metadata entries with checksum. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Fget_metadata_read_retry_info.htm

Declaration

public static System.Int32 get_metadata_read_retry_info(System.Int64 file_id, ref H5F.retry_info_t info)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier for a currently opened HDF5 file.
H5F.retry_info_t	info	Struct containing the collection of read retries for metadata entries with checksum.

Returns

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

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

Retrieves name of file to which object belongs. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetName

Declaration

public static System.IntPtr get_name(System.Int64 obj_id, StringBuilder name, System.IntPtr size)

Parameters

Type	Name	Description
System.Int64	obj_id	Identifier of the object for which the associated filename is sought.
StringBuilder	name	Buffer to contain the returned filename.
System.IntPtr	size	Buffer size, in bytes.

Returns

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

get_obj_count(System.Int64, UInt32)

Returns the number of open object identifiers for an open file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetObjCount

Declaration

public static System.IntPtr get_obj_count(System.Int64 file_id, uint types)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of a currently-open HDF5 file.
System.UInt32	types	Type of object for which identifiers are to be returned.

Returns

Type	Description
System.IntPtr	Returns the number of open objects if successful; otherwise returns a negative value.

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

Returns a list of open object identifiers. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetObjIDs

Declaration

public static System.IntPtr get_obj_ids(System.Int64 file_id, uint types, System.IntPtr max_objs, IntPtr obj_id_list)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of a currently-open HDF5 file.
System.UInt32	types	Type of object for which identifiers are to be returned.
System.IntPtr	max_objs	Maximum number of object identifiers to be returned.
IntPtr	obj_id_list	Pointer to the returned list of open object identifiers.

Returns

Type	Description
System.IntPtr	Returns number of objects placed into obj_id_list if successful; otherwise returns a negative value.

get_page_buffering_stats(System.Int64, Int32, Int32, Int32, Int32, Int32)

Retrieves statistics about page access when it is enabled. See https://support.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetPBStats

Declaration

public static System.Int32 get_page_buffering_stats(System.Int64 file_id, int accesses, int hits, int misses, int evictions, int bypasses)

Parameters

Type	Name	Description
System.Int64	file_id	File identifier
System.Int32	accesses	Two integer array for the number of metadata and raw data accesses to the page buffer
System.Int32	hits	Two integer array for the number of metadata and raw data hits in the page buffer
System.Int32	misses	Two integer array for the number of metadata and raw data misses in the page buffer
System.Int32	evictions	Two integer array for the number of metadata and raw data evictions from the page buffer
System.Int32	bypasses	Two integer array for the number of metadata and raw data accesses that bypass the page buffer

Returns

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

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

Returns pointer to the file handle from the virtual file driver. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-GetVfdHandle

Declaration

public static System.Int32 get_vfd_handle(System.Int64 file_id, System.Int64 fapl, ref IntPtr file_handle)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of the file to be queried.
System.Int64	fapl	File access property list identifier.
IntPtr	file_handle	Pointer to the file handle being used by the low-level virtual file driver.

Returns

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

is_hdf5(String)

Determines whether a file is in the HDF5 format. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-IsHDF5

Declaration

public static System.Int32 is_hdf5(string filename)

Parameters

Type	Name	Description
System.String	filename

Returns

Type	Description
System.Int32	When successful, returns a positive value, for TRUE, or 0 (zero), for FALSE. On any error, including the case that the file does not exist, returns a negative value.

Remarks

filename MUST be an ASCII string.

mount(System.Int64, Byte[], System.Int64, System.Int64)

Mounts a file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-Mount

Declaration

public static System.Int32 mount(System.Int64 loc, byte[] name, System.Int64 child, System.Int64 plist = null)

Parameters

Type	Name	Description
System.Int64	loc	Identifier for of file or group in which name is defined.
System.Byte[]	name	Name of the group onto which the file specified by `child` is to be mounted.
System.Int64	child	Identifier of the file to be mounted.
System.Int64	plist	File mount property list identifier.

Returns

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

mount(System.Int64, String, System.Int64, System.Int64)

Mounts a file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-Mount

Declaration

public static System.Int32 mount(System.Int64 loc, string name, System.Int64 child, System.Int64 plist = null)

Parameters

Type	Name	Description
System.Int64	loc	Identifier for of file or group in which name is defined.
System.String	name	Name of the group onto which the file specified by `child` is to be mounted.
System.Int64	child	Identifier of the file to be mounted.
System.Int64	plist	File mount property list identifier.

Returns

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

Remarks

ASCII strings ONLY!

open(String, UInt32, System.Int64)

Opens an existing HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-Open

Declaration

public static System.Int64 open(string filename, uint flags, System.Int64 plist = null)

Parameters

Type	Name	Description
System.String	filename	Name of the file to be opened.
System.UInt32	flags	File access flags. ( `H5F_ACC_RDWR` or `H5F_ACC_RDONLY` )
System.Int64	plist	Identifier for the file access properties list.

Returns

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

Remarks

filename MUST be an ASCII string!

reopen(System.Int64)

Returns a new identifier for a previously-opened HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-Reopen

Declaration

public static System.Int64 reopen(System.Int64 file_id)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of a file for which an additional identifier is required.

Returns

Type	Description
System.Int64	Returns a new file identifier if successful; otherwise returns a negative value.

reset_mdc_hit_rate_stats(System.Int64)

Reset hit rate statistics counters for the target file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-ResetMdcHitRateStats

Declaration

public static System.Int32 reset_mdc_hit_rate_stats(System.Int64 file_id)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of the target file.

Returns

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

reset_page_buffering_stats(System.Int64)

Resets the page buffer statistics. See https://support.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-ResetPBStats

Declaration

public static System.Int32 reset_page_buffering_stats(System.Int64 file_id)

Parameters

Type	Name	Description
System.Int64	file_id	File identifier

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/H5F_SET_DSET_NO_ATTRS_HINT

Declaration

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

Parameters

Type	Name	Description
System.Int64	file_id	File 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_mdc_config(System.Int64, ref H5AC.cache_config_t)

Attempt to configure metadata cache of target file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-SetMdcConfig

Declaration

public static System.Int32 set_mdc_config(System.Int64 file_id, ref H5AC.cache_config_t config_ptr)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of the target file
H5AC.cache_config_t	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.

start_mdc_logging(System.Int64)

Starts logging metadata cache events if logging was previously enabled. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Fstart_mdc_logging.htm

Declaration

public static System.Int32 start_mdc_logging(System.Int64 file_id)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of an open HDF5 file.

Returns

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

start_swmr_write(System.Int64)

Enables SWMR writing mode for a file. See https://www.hdfgroup.org/HDF5/docNewFeatures/SWMR/H5Fstart_swmr_write.htm

Declaration

public static System.Int32 start_swmr_write(System.Int64 file_id)

Parameters

Type	Name	Description
System.Int64	file_id	A file identifier.

Returns

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

stop_mdc_logging(System.Int64)

Stops logging metadata cache events if logging was previously enabled and is currently ongoing. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Fstop_mdc_logging.htm

Declaration

public static System.Int32 stop_mdc_logging(System.Int64 file_id)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of an open HDF5 file.

Returns

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

unmount(System.Int64, Byte[])

Unmounts a file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-Unmount

Declaration

public static System.Int32 unmount(System.Int64 loc, byte[] name)

Parameters

Type	Name	Description
System.Int64	loc	File or group identifier for the location at which the specified file is to be unmounted.
System.Byte[]	name	Name of the mount point.

Returns

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

unmount(System.Int64, String)

Unmounts a file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5F.html#File-Unmount

Declaration

public static System.Int32 unmount(System.Int64 loc, string name)

Parameters

Type	Name	Description
System.Int64	loc	File or group identifier for the location at which the specified file is to be unmounted.
System.String	name	Name of the mount point.

Returns

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

Remarks

ASCII strings ONLY!