Class H5O

Inheritance

System.Object

H5O

Namespace: HDF.PInvoke

Assembly: HDF.PInvoke.dll

Syntax

public sealed class H5O : object

Fields

| Improve this Doc View Source

COPY_ALL

All object copying flags (for internal checking

Declaration

public const uint COPY_ALL = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

COPY_EXPAND_EXT_LINK_FLAG

Expand external links into new objects

Declaration

public const uint COPY_EXPAND_EXT_LINK_FLAG = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

COPY_EXPAND_REFERENCE_FLAG

Copy objects that are pointed by references

Declaration

public const uint COPY_EXPAND_REFERENCE_FLAG = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

COPY_EXPAND_SOFT_LINK_FLAG

Expand soft links into new objects

Declaration

public const uint COPY_EXPAND_SOFT_LINK_FLAG = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

COPY_MERGE_COMMITTED_DTYPE_FLAG

Merge committed datatypes in dest file

Declaration

public const uint COPY_MERGE_COMMITTED_DTYPE_FLAG = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

COPY_PRESERVE_NULL_FLAG

Copy

NULL

messages (empty space)

Declaration

public const uint COPY_PRESERVE_NULL_FLAG = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

COPY_SHALLOW_HIERARCHY_FLAG

Copy only immediate members

Declaration

public const uint COPY_SHALLOW_HIERARCHY_FLAG = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

COPY_WITHOUT_ATTR_FLAG

Copy object without copying attributes

Declaration

public const uint COPY_WITHOUT_ATTR_FLAG = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

HDR_ALL_FLAGS

Declaration

public const uint HDR_ALL_FLAGS = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

HDR_ATTR_CRT_ORDER_INDEXED

Attribute creation order has index

Declaration

public const uint HDR_ATTR_CRT_ORDER_INDEXED = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

HDR_ATTR_CRT_ORDER_TRACKED

Attribute creation order is tracked

Declaration

public const uint HDR_ATTR_CRT_ORDER_TRACKED = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

HDR_ATTR_STORE_PHASE_CHANGE

Non-default attribute storage phase change values stored

Declaration

public const uint HDR_ATTR_STORE_PHASE_CHANGE = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

HDR_CHUNK0_SIZE

2-bit field indicating # of bytes to store the size of chunk 0's data

Declaration

public const uint HDR_CHUNK0_SIZE = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

HDR_STORE_TIMES

Store access, modification, change and birth times for object

Declaration

public const uint HDR_STORE_TIMES = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

SHMESG_ALL_FLAG

Declaration

public const uint SHMESG_ALL_FLAG = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

SHMESG_ATTR_FLAG

Attribute Message.

Declaration

public const uint SHMESG_ATTR_FLAG = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

SHMESG_DTYPE_FLAG

Datatype Message.

Declaration

public const uint SHMESG_DTYPE_FLAG = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

SHMESG_FILL_FLAG

Fill Value Message.

Declaration

public const uint SHMESG_FILL_FLAG = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

SHMESG_MAX_LIST_SIZE

Declaration

public const uint SHMESG_MAX_LIST_SIZE = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

SHMESG_MAX_NINDEXES

Declaration

public const uint SHMESG_MAX_NINDEXES = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

SHMESG_NONE_FLAG

No shared messages

Declaration

public const uint SHMESG_NONE_FLAG = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

SHMESG_PLINE_FLAG

Filter pipeline message.

Declaration

public const uint SHMESG_PLINE_FLAG = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

SHMESG_SDSPACE_FLAG

Simple Dataspace Message.

Declaration

public const uint SHMESG_SDSPACE_FLAG = null

Field Value

Type	Description
System.UInt32

Methods

are_mdc_flushes_disabled(System.Int64, ref System.UInt32)

Determines if an HDF5 object (dataset, group, committed datatype) has had flushes of metadata entries disabled. See https://www.hdfgroup.org/HDF5/docNewFeatures/SWMR/H5Oare_mdc_flushes_disabled.htm

Declaration

public static System.Int32 are_mdc_flushes_disabled(System.Int64 object_id, ref System.UInt32 are_disabled)

Parameters

Type	Name	Description
System.Int64	object_id	Identifier of an object in the cache.
System.UInt32	are_disabled	Flushes enabled/disabled.

Returns

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

close(System.Int64)

Closes an object in an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-Close

Declaration

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

Parameters

Type	Name	Description
System.Int64	object_id	Object identifier

Returns

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

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

Copies an object in an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-Copy

Declaration

public static System.Int32 copy(System.Int64 src_loc_id, byte[] src_name, System.Int64 dst_loc_id, byte[] dst_name, System.Int64 ocpypl_id = null, System.Int64 lcpl_id = null)

Parameters

Type	Name	Description
System.Int64	src_loc_id	Object identifier indicating the location of the source object to be copied
System.Byte[]	src_name	Name of the source object to be copied
System.Int64	dst_loc_id	Location identifier specifying the destination
System.Byte[]	dst_name	Name to be assigned to the new copy
System.Int64	ocpypl_id	Object copy property list
System.Int64	lcpl_id	Link creation property list for the new hard link

Returns

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

copy(System.Int64, String, System.Int64, String, System.Int64, System.Int64)

Copies an object in an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-Copy

Declaration

public static System.Int32 copy(System.Int64 src_loc_id, string src_name, System.Int64 dst_loc_id, string dst_name, System.Int64 ocpypl_id = null, System.Int64 lcpl_id = null)

Parameters

Type	Name	Description
System.Int64	src_loc_id	Object identifier indicating the location of the source object to be copied
System.String	src_name	Name of the source object to be copied
System.Int64	dst_loc_id	Location identifier specifying the destination
System.String	dst_name	Name to be assigned to the new copy
System.Int64	ocpypl_id	Object copy property list
System.Int64	lcpl_id	Link creation property list for the new hard link

Returns

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

Remarks

ASCII strings ONLY!

decr_refcount(System.Int64)

Decrements an object's reference count. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-DecrRefCount

Declaration

public static System.Int32 decr_refcount(System.Int64 object_id)

Parameters

Type	Name	Description
System.Int64	object_id	Object identifier

Returns

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

Remarks

This function must be used with care! Improper use can lead to inaccessible data, wasted space in the file, or file corruption.

disable_mdc_flushes(System.Int64)

Prevents metadata entries for an HDF5 object from being flushed from the metadata cache to storage. See https://www.hdfgroup.org/HDF5/docNewFeatures/SWMR/H5Odisable_mdc_flushes.htm

Declaration

public static System.Int32 disable_mdc_flushes(System.Int64 object_id)

Parameters

Type	Name	Description
System.Int64	object_id	Identifier of the object that will have flushes disabled.

Returns

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

enable_mdc_flushes(System.Int64)

Allow metadata entries for an HDF5 object to be flushed from the metadata cache to storage. See https://www.hdfgroup.org/HDF5/docNewFeatures/SWMR/H5Oenable_mdc_flushes.htm

Declaration

public static System.Int32 enable_mdc_flushes(System.Int64 object_id)

Parameters

Type	Name	Description
System.Int64	object_id	Identifier of the object that will have flushes (re-)enabled.

Returns

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

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

Determines whether a link resolves to an actual object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-ExistsByName

Declaration

public static System.Int32 exists_by_name(System.Int64 loc_id, byte[] name, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	Identifier of the file or group to query.
System.Byte[]	name	The name of the link to check.
System.Int64	lapl_id	Link access property list identifier.

Returns

Type	Description
System.Int32	Returns 1 or 0 if successful; otherwise returns a negative value.

exists_by_name(System.Int64, String, System.Int64)

Determines whether a link resolves to an actual object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-ExistsByName

Declaration

public static System.Int32 exists_by_name(System.Int64 loc_id, string name, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	Identifier of the file or group to query.
System.String	name	The name of the link to check.
System.Int64	lapl_id	Link access property list identifier.

Returns

Type	Description
System.Int32	Returns 1 or 0 if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

flush(System.Int64)

Flushes all buffers associated with an HDF5 object to disk. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Oflush.htm

Declaration

public static System.Int32 flush(System.Int64 obj_id)

Parameters

Type	Name	Description
System.Int64	obj_id	Identifier of the object to be flushed.

Returns

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

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

Retrieves comment for specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-GetComment

Declaration

public static System.IntPtr get_comment(System.Int64 obj_id, StringBuilder comment, System.IntPtr size)

Parameters

Type	Name	Description
System.Int64	obj_id	Identifier for the target object.
StringBuilder	comment	The comment.
System.IntPtr	size	Size of the `comment` buffer.

Returns

Type	Description
System.IntPtr	Upon success, returns the number of characters in the comment, not including the `NULL` terminator, or zero (0) if the object has no comment. The value returned may be larger than `size` . Otherwise returns a negative value.

get_comment_by_name(System.Int64, Byte[], StringBuilder, System.IntPtr, System.Int64)

Retrieves comment for specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-GetCommentByName

Declaration

public static System.IntPtr get_comment_by_name(System.Int64 loc_id, byte[] name, StringBuilder comment, System.IntPtr size, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	Identifier of a file, group, dataset, or named datatype.
System.Byte[]	name	Name of the object whose comment is to be retrieved, specified as a path relative to `loc_id`.
StringBuilder	comment	The comment.
System.IntPtr	size	Size of the `comment` buffer.
System.Int64	lapl_id	Link access property list identifier.

Returns

Type	Description
System.IntPtr	Upon success, returns the number of characters in the comment, not including the `NULL` terminator, or zero (0) if the object has no comment. The value returned may be larger than `size`. Otherwise returns a negative value.

get_comment_by_name(System.Int64, String, StringBuilder, System.IntPtr, System.Int64)

Retrieves comment for specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-GetCommentByName

Declaration

public static System.IntPtr get_comment_by_name(System.Int64 loc_id, string name, StringBuilder comment, System.IntPtr size, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	Identifier of a file, group, dataset, or named datatype.
System.String	name	Name of the object whose comment is to be retrieved, specified as a path relative to `loc_id`.
StringBuilder	comment	The comment.
System.IntPtr	size	Size of the `comment` buffer.
System.Int64	lapl_id	Link access property list identifier.

Returns

Type	Description
System.IntPtr	Upon success, returns the number of characters in the comment, not including the `NULL` terminator, or zero (0) if the object has no comment. The value returned may be larger than `size`. Otherwise returns a negative value.

Remarks

ASCII strings ONLY!

get_info(System.Int64, ref H5O.info_t)

Retrieves the metadata for an object specified by an identifier. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-GetInfo

Declaration

public static System.Int32 get_info(System.Int64 loc_id, ref H5O.info_t oinfo)

Parameters

Type	Name	Description
System.Int64	loc_id	Identifier for object of type specified by `H5O.type_t`
H5O.info_t	oinfo	Buffer in which to return object information

Returns

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

get_info_by_idx(System.Int64, Byte[], H5.index_t, H5.iter_order_t, System.UInt64, ref H5O.info_t, System.Int64)

Retrieves the metadata for an object, identifying the object by an index position. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-GetInfoByIdx

Declaration

public static System.Int32 get_info_by_idx(System.Int64 loc_id, byte[] group_name, H5.index_t idx_type, H5.iter_order_t order, System.UInt64 n, ref H5O.info_t oinfo, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier specifying location of group in which object is located
System.Byte[]	group_name	Name of group in which object is located
H5.index_t	idx_type	Index or field that determines the order
H5.iter_order_t	order	Order within field or index
System.UInt64	n	Object for which information is to be returned
H5O.info_t	oinfo	Buffer in which to return object information
System.Int64	lapl_id	Link access property list

Returns

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

get_info_by_idx(System.Int64, String, H5.index_t, H5.iter_order_t, System.UInt64, ref H5O.info_t, System.Int64)

Retrieves the metadata for an object, identifying the object by an index position. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-GetInfoByIdx

Declaration

public static System.Int32 get_info_by_idx(System.Int64 loc_id, string group_name, H5.index_t idx_type, H5.iter_order_t order, System.UInt64 n, ref H5O.info_t oinfo, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier specifying location of group in which object is located
System.String	group_name	Name of group in which object is located
H5.index_t	idx_type	Index or field that determines the order
H5.iter_order_t	order	Order within field or index
System.UInt64	n	Object for which information is to be returned
H5O.info_t	oinfo	Buffer in which to return object information
System.Int64	lapl_id	Link access property list

Returns

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

Remarks

ASCII strings ONLY!

get_info_by_name(System.Int64, Byte[], ref H5O.info_t, System.Int64)

Retrieves the metadata for an object, identifying the object by location and relative name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-GetInfoByName

Declaration

public static System.Int32 get_info_by_name(System.Int64 loc_id, byte[] name, ref H5O.info_t oinfo, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier specifying location of group in which object is located
System.Byte[]	name	Name of object, relative to `loc_id`
H5O.info_t	oinfo	Buffer in which to return object information
System.Int64	lapl_id	Link access property list

Returns

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

get_info_by_name(System.Int64, String, ref H5O.info_t, System.Int64)

Retrieves the metadata for an object, identifying the object by location and relative name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-GetInfoByName

Declaration

public static System.Int32 get_info_by_name(System.Int64 loc_id, string name, ref H5O.info_t oinfo, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier specifying location of group in which object is located
System.String	name	Name of group, relative to `loc_id`
H5O.info_t	oinfo	Buffer in which to return object information
System.Int64	lapl_id	Link access property list

Returns

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

Remarks

ASCII strings ONLY!

incr_refcount(System.Int64)

Increments an object's reference count. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-IncrRefCount

Declaration

public static System.Int32 incr_refcount(System.Int64 object_id)

Parameters

Type	Name	Description
System.Int64	object_id	Object identifier

Returns

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

Remarks

This function must be used with care! Improper use can lead to inaccessible data, wasted space in the file, or file corruption.

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

Creates a hard link to an object in an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-Link

Declaration

public static System.Int32 link(System.Int64 obj_id, System.Int64 new_loc_id, byte[] new_name, System.Int64 lcpl_id = null, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	obj_id	Object to be linked.
System.Int64	new_loc_id	File or group identifier specifying location at which object is to be linked.
System.Byte[]	new_name	Name of link to be created, relative to `new_loc_id`.
System.Int64	lcpl_id	Link creation property list identifier.
System.Int64	lapl_id	Link access property list identifier.

Returns

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

link(System.Int64, System.Int64, String, System.Int64, System.Int64)

Creates a hard link to an object in an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-Link

Declaration

public static System.Int32 link(System.Int64 obj_id, System.Int64 new_loc_id, string new_name, System.Int64 lcpl_id = null, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	obj_id	Object to be linked.
System.Int64	new_loc_id	File or group identifier specifying location at which object is to be linked.
System.String	new_name	Name of link to be created, relative to `new_loc_id`.
System.Int64	lcpl_id	Link creation property list identifier.
System.Int64	lapl_id	Link access 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(System.Int64, Byte[], System.Int64)

Opens an object in an HDF5 file by location identifier and path name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-Open

Declaration

public static System.Int64 open(System.Int64 loc_id, byte[] name, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier
System.Byte[]	name	Path to the object, relative to `loc_id`.
System.Int64	lapl_id	Access property list identifier for the link pointing to the object

Returns

Type	Description
System.Int64	Returns an object identifier for the opened object if successful; otherwise returns a negative value.

open(System.Int64, String, System.Int64)

Opens an object in an HDF5 file by location identifier and path name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-Open

Declaration

public static System.Int64 open(System.Int64 loc_id, string name, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier
System.String	name	Path to the object, relative to `loc_id`.
System.Int64	lapl_id	Access property list identifier for the link pointing to the object

Returns

Type	Description
System.Int64	Returns an object identifier for the opened object if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

open_by_addr(System.Int64, System.UInt64)

Opens an object using its address within an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-OpenByAddr

Declaration

public static System.Int64 open_by_addr(System.Int64 loc_id, System.UInt64 addr)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier
System.UInt64	addr	Object’s address in the file

Returns

Type	Description
System.Int64	Returns an object identifier for the opened object if successful; otherwise returns a negative value.

Remarks

This function must be used with care! Improper use can lead to inaccessible data, wasted space in the file, or file corruption.

open_by_idx(System.Int64, Byte[], H5.index_t, H5.iter_order_t, System.UInt64, System.Int64)

Open the n-th object in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-OpenByIdx

Declaration

public static System.Int64 open_by_idx(System.Int64 loc_id, byte[] group_name, H5.index_t idx_type, H5.iter_order_t order, System.UInt64 n, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	A file or group identifier.
System.Byte[]	group_name	Name of group, relative to `loc_id`, in which object is located
H5.index_t	idx_type	Type of index by which objects are ordered
H5.iter_order_t	order	Order of iteration within index
System.UInt64	n	Object to open
System.Int64	lapl_id	Link access property list

Returns

Type	Description
System.Int64	Returns an object identifier for the opened object if successful; otherwise returns a negative value.

open_by_idx(System.Int64, String, H5.index_t, H5.iter_order_t, System.UInt64, System.Int64)

Open the n-th object in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-OpenByIdx

Declaration

public static System.Int64 open_by_idx(System.Int64 loc_id, string group_name, H5.index_t idx_type, H5.iter_order_t order, System.UInt64 n, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	A file or group identifier.
System.String	group_name	Name of group, relative to `loc_id`, in which object is located
H5.index_t	idx_type	Type of index by which objects are ordered
H5.iter_order_t	order	Order of iteration within index
System.UInt64	n	Object to open
System.Int64	lapl_id	Link access property list

Returns

Type	Description
System.Int64	Returns an object identifier for the opened object if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

refresh(System.Int64)

Refreshes all buffers associated with an HDF5 object. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Orefresh.htm

Declaration

public static System.Int32 refresh(System.Int64 oid)

Parameters

Type	Name	Description
System.Int64	oid	Identifier of the object to be refreshed.

Returns

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

visit(System.Int64, H5.index_t, H5.iter_order_t, H5O.iterate_t, IntPtr)

Recursively visits all objects accessible from a specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-Visit

Declaration

public static System.Int32 visit(System.Int64 obj_id, H5.index_t idx_type, H5.iter_order_t order, H5O.iterate_t op, IntPtr op_data)

Parameters

Type	Name	Description
System.Int64	obj_id	Identifier of the object at which the recursive iteration begins.
H5.index_t	idx_type	Type of index
H5.iter_order_t	order	Order in which index is traversed
H5O.iterate_t	op	Callback function passing data regarding the object to the calling application
IntPtr	op_data	User-defined pointer to data required by the application for its processing of the object

Returns

Type	Description
System.Int32	On success, returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero. On failure, returns a negative value if something goes wrong within the library, or the first negative value returned by an operator.

visit_by_name(System.Int64, Byte[], H5.index_t, H5.iter_order_t, H5O.iterate_t, IntPtr, System.Int64)

Recursively visits all objects starting from a specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-VisitByName

Declaration

public static System.Int32 visit_by_name(System.Int64 loc_id, byte[] obj_name, H5.index_t idx_type, H5.iter_order_t order, H5O.iterate_t op, IntPtr op_data, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	Identifier of a file or group
System.Byte[]	obj_name	Name of the object, generally relative to `loc_id`, that will serve as root of the iteration
H5.index_t	idx_type	Type of index
H5.iter_order_t	order	Order in which index is traversed
H5O.iterate_t	op	Callback function passing data regarding the object to the calling application
IntPtr	op_data	User-defined pointer to data required by the application for its processing of the object
System.Int64	lapl_id	Link access property list identifier

Returns

Type	Description
System.Int32	On success, returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero. On failure, returns a negative value if something goes wrong within the library, or the first negative value returned by an operator.

visit_by_name(System.Int64, String, H5.index_t, H5.iter_order_t, H5O.iterate_t, IntPtr, System.Int64)

Recursively visits all objects starting from a specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5O.html#Object-VisitByName

Declaration

public static System.Int32 visit_by_name(System.Int64 loc_id, string obj_name, H5.index_t idx_type, H5.iter_order_t order, H5O.iterate_t op, IntPtr op_data, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	Identifier of a file or group
System.String	obj_name	Name of the object, generally relative to `loc_id`, that will serve as root of the iteration
H5.index_t	idx_type	Type of index
H5.iter_order_t	order	Order in which index is traversed
H5O.iterate_t	op	Callback function passing data regarding the object to the calling application
IntPtr	op_data	User-defined pointer to data required by the application for its processing of the object
System.Int64	lapl_id	Link access property list identifier

Returns

Type	Description
System.Int32	On success, returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero. On failure, returns a negative value if something goes wrong within the library, or the first negative value returned by an operator.