Class H5L

Inheritance

System.Object

H5L

Namespace: HDF.PInvoke

Assembly: HDF.PInvoke.dll

Syntax

public sealed class H5L : object

Fields

| Improve this Doc View Source

LINK_CLASS_T_VERS

Current version of the class_t struct

Declaration

public const int LINK_CLASS_T_VERS = null

Field Value

Type	Description
System.Int32

| Improve this Doc View Source

MAX_LINK_NAME_LEN

Maximum length of a link's name (encoded in a 32-bit unsigned integer: 4GB - 1)

Declaration

public const UInt32 MAX_LINK_NAME_LEN = null

Field Value

Type	Description
UInt32

| Improve this Doc View Source

SAME_LOC

Constant to indicate operation occurs on same location

Declaration

public const System.Int64 SAME_LOC = null

Field Value

Type	Description
System.Int64

| Improve this Doc View Source

TYPE_BUILTIN_MAX

Maximum value link value for "built-in" link types

Declaration

public const H5L.type_t TYPE_BUILTIN_MAX = default(H5L.type_t)

Field Value

Type	Description
H5L.type_t

| Improve this Doc View Source

TYPE_UD_MIN

Link ids at or above this value are "user-defined" link types.

Declaration

public const H5L.type_t TYPE_UD_MIN = default(H5L.type_t)

Field Value

Type	Description
H5L.type_t

Methods

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

Copies a link from one location to another. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Copy

Declaration

public static System.Int32 copy(System.Int64 src_loc, byte[] src_name, System.Int64 dst_loc, byte[] dst_name, System.Int64 lcpl_id = null, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	src_loc	Location identifier of the source link
System.Byte[]	src_name	Name of the link to be copied
System.Int64	dst_loc	Location identifier specifying the destination of the copy
System.Byte[]	dst_name	Name to be assigned to the new copy
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.

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

Copies a link from one location to another. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Copy

Declaration

public static System.Int32 copy(System.Int64 src_loc, string src_name, System.Int64 dst_loc, string dst_name, System.Int64 lcpl_id = null, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	src_loc	Location identifier of the source link
System.String	src_name	Name of the link to be copied
System.Int64	dst_loc	Location identifier specifying the destination of the copy
System.String	dst_name	Name to be assigned to the new copy
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!

create_external(String, Byte[], System.Int64, Byte[], System.Int64, System.Int64)

Creates an external link, a soft link to an object in a different file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-CreateExternal

Declaration

public static System.Int32 create_external(string file_name, byte[] obj_name, System.Int64 link_loc_id, byte[] link_name, System.Int64 lcpl_id = null, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.String	file_name	Name of the target file containing the target object
System.Byte[]	obj_name	Path within the target file to the target object
System.Int64	link_loc_id	File or group identifier where the new link is to be created
System.Byte[]	link_name	Name of the new link, relative to `link_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

The file_name must be an ASCII string!

create_external(String, String, System.Int64, String, System.Int64, System.Int64)

Creates an external link, a soft link to an object in a different file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-CreateExternal

Declaration

public static System.Int32 create_external(string file_name, string obj_name, System.Int64 link_loc_id, string link_name, System.Int64 lcpl_id = null, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.String	file_name	Name of the target file containing the target object
System.String	obj_name	Path within the target file to the target object
System.Int64	link_loc_id	File or group identifier where the new link is to be created
System.String	link_name	Name of the new link, relative to `link_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!

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

Creates a hard link to an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-CreateHard

Declaration

public static System.Int32 create_hard(System.Int64 cur_loc, byte[] cur_name, System.Int64 dst_loc, byte[] dst_name, System.Int64 lcpl_id = null, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	cur_loc	The file or group identifier for the target object.
System.Byte[]	cur_name	Name of the target object, which must already exist.
System.Int64	dst_loc	The file or group identifier for the new link.
System.Byte[]	dst_name	The name of the new link.
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.

create_hard(System.Int64, String, System.Int64, String, System.Int64, System.Int64)

Creates a hard link to an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-CreateHard

Declaration

public static System.Int32 create_hard(System.Int64 cur_loc, string cur_name, System.Int64 dst_loc, string dst_name, System.Int64 lcpl_id = null, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	cur_loc	The file or group identifier for the target object.
System.String	cur_name	Name of the target object, which must already exist.
System.Int64	dst_loc	The file or group identifier for the new link.
System.String	dst_name	The name of the new link.
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!

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

Creates a soft link to an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-CreateSoft

Declaration

public static System.Int32 create_soft(byte[] link_target, System.Int64 link_loc_id, byte[] link_name, System.Int64 lcpl_id = null, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Byte[]	link_target	Path to the target object, which is not required to exist.
System.Int64	link_loc_id	The file or group identifier for the new link.
System.Byte[]	link_name	The name of the new link.
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.

create_soft(String, System.Int64, String, System.Int64, System.Int64)

Creates a soft link to an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-CreateSoft

Declaration

public static System.Int32 create_soft(string link_target, System.Int64 link_loc_id, string link_name, System.Int64 lcpl_id = null, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.String	link_target	Path to the target object, which is not required to exist.
System.Int64	link_loc_id	The file or group identifier for the new link.
System.String	link_name	The name of the new link.
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!

create_ud(System.Int64, Byte[], H5L.type_t, IntPtr, System.IntPtr, System.Int64, System.Int64)

Creates a link of a user-defined type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-CreateUD

Declaration

public static System.Int32 create_ud(System.Int64 link_loc_id, byte[] link_name, H5L.type_t link_type, IntPtr udata, System.IntPtr udata_size, System.Int64 lcpl_id = null, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	link_loc_id	Link location identifier
System.Byte[]	link_name	Link name
H5L.type_t	link_type	User-defined link class
IntPtr	udata	User-supplied link information
System.IntPtr	udata_size	Size of udata buffer
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.

create_ud(System.Int64, String, H5L.type_t, IntPtr, System.IntPtr, System.Int64, System.Int64)

Creates a link of a user-defined type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-CreateUD

Declaration

public static System.Int32 create_ud(System.Int64 link_loc_id, string link_name, H5L.type_t link_type, IntPtr udata, System.IntPtr udata_size, System.Int64 lcpl_id = null, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	link_loc_id	Link location identifier
System.String	link_name	Link name
H5L.type_t	link_type	User-defined link class
IntPtr	udata	User-supplied link information
System.IntPtr	udata_size	Size of udata buffer
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!

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

Removes a link from a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Delete

Declaration

public static System.Int32 delete(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 containing the object.
System.Byte[]	name	Name of the link to delete.
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.

delete(System.Int64, String, System.Int64)

Removes a link from a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Delete

Declaration

public static System.Int32 delete(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 containing the object.
System.String	name	Name of the link to delete.
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!

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

Removes the n-th link in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-DeleteByIdx

Declaration

public static System.Int32 delete_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	File or group identifier specifying location of subject group
System.Byte[]	group_name	Name of subject group
H5.index_t	idx_type	Index or field which determines the order
H5.iter_order_t	order	Order within field or index
System.UInt64	n	Link for which to retrieve 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.

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

Removes the n-th link in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-DeleteByIdx

Declaration

public static System.Int32 delete_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	File or group identifier specifying location of subject group
System.String	group_name	Name of subject group
H5.index_t	idx_type	Index or field which determines the order
H5.iter_order_t	order	Order within field or index
System.UInt64	n	Link for which to retrieve 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!

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

Determine whether a link with the specified name exists in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Exists

Declaration

public static System.Int32 exists(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(System.Int64, String, System.Int64)

Determine whether a link with the specified name exists in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Exists

Declaration

public static System.Int32 exists(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!

get_info(System.Int64, Byte[], ref H5L.info_t, System.Int64)

Returns information about a link. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetInfo

Declaration

public static System.Int32 get_info(System.Int64 loc_id, byte[] name, ref H5L.info_t linfo, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier.
System.Byte[]	name	Name of the link for which information is being sought.
H5L.info_t	linfo	Buffer in which link information is returned.
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.

get_info(System.Int64, String, ref H5L.info_t, System.Int64)

Returns information about a link. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetInfo

Declaration

public static System.Int32 get_info(System.Int64 loc_id, string name, ref H5L.info_t linfo, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier.
System.String	name	Name of the link for which information is being sought.
H5L.info_t	linfo	Buffer in which link information is returned.
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!

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

Retrieves metadata for a link in a group, according to the order within a field or index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-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 H5L.info_t linfo, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier specifying location of subject group
System.Byte[]	group_name	Name of subject group
H5.index_t	idx_type	Index or field which determines the order
H5.iter_order_t	order	Order within field or index
System.UInt64	n	Link for which to retrieve information
H5L.info_t	linfo	Buffer in which link value is returned
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 H5L.info_t, System.Int64)

Retrieves metadata for a link in a group, according to the order within a field or index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-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 H5L.info_t linfo, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier specifying location of subject group
System.String	group_name	Name of subject group
H5.index_t	idx_type	Index or field which determines the order
H5.iter_order_t	order	Order within field or index
System.UInt64	n	Link for which to retrieve information
H5L.info_t	linfo	Buffer in which link value is returned
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_name_by_idx(System.Int64, Byte[], H5.index_t, H5.iter_order_t, System.UInt64, Byte[], System.IntPtr, System.Int64)

Retrieves name of the nth link in a group, according to the order within a specified field or index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetNameByIdx

Declaration

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

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier specifying location of subject group
System.Byte[]	group_name	Name of subject group
H5.index_t	idx_type	Index or field which determines the order
H5.iter_order_t	order	Order within field or index
System.UInt64	n	Link for which to retrieve information
System.Byte[]	name	Buffer in which link value is returned
System.IntPtr	size	Size in bytes of `name`
System.Int64	lapl_id	Link access property list

Returns

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

get_name_by_idx(System.Int64, String, H5.index_t, H5.iter_order_t, System.UInt64, IntPtr, System.IntPtr, System.Int64)

Retrieves name of the nth link in a group, according to the order within a specified field or index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetNameByIdx

Declaration

public static System.IntPtr get_name_by_idx(System.Int64 loc_id, string group_name, H5.index_t idx_type, H5.iter_order_t order, System.UInt64 n, IntPtr name, System.IntPtr size, System.Int64 lapl_id)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier specifying location of subject group
System.String	group_name	Name of subject group
H5.index_t	idx_type	Index or field which determines the order
H5.iter_order_t	order	Order within field or index
System.UInt64	n	Link for which to retrieve information
IntPtr	name	Buffer in which link value is returned
System.IntPtr	size	Size in bytes of `name`
System.Int64	lapl_id	Link access property list

Returns

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

Remarks

ASCII strings ONLY!

get_name_by_idx(System.Int64, String, H5.index_t, H5.iter_order_t, System.UInt64, StringBuilder, System.IntPtr, System.Int64)

Retrieves name of the nth link in a group, according to the order within a specified field or index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetNameByIdx

Declaration

public static System.IntPtr get_name_by_idx(System.Int64 loc_id, string group_name, H5.index_t idx_type, H5.iter_order_t order, System.UInt64 n, StringBuilder name, System.IntPtr size, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier specifying location of subject group
System.String	group_name	Name of subject group
H5.index_t	idx_type	Index or field which determines the order
H5.iter_order_t	order	Order within field or index
System.UInt64	n	Link for which to retrieve information
StringBuilder	name	Buffer in which link value is returned
System.IntPtr	size	Size in bytes of `name`
System.Int64	lapl_id	Link access property list

Returns

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

Remarks

ASCII strings ONLY!

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

Returns the value of a symbolic link. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetVal

Declaration

public static System.Int32 get_val(System.Int64 loc_id, byte[] name, IntPtr buf, System.IntPtr size, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier.
System.Byte[]	name	Link whose value is to be returned.
IntPtr	buf	The buffer to hold the returned link value.
System.IntPtr	size	Maximum number of characters of link value to be returned.
System.Int64	lapl_id	List access property list identifier.

Returns

Type	Description
System.Int32	Returns a non-negative value, with the link value in `buf`, if successful. Otherwise returns a negative value.

get_val(System.Int64, String, IntPtr, System.IntPtr, System.Int64)

Returns the value of a symbolic link. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetVal

Declaration

public static System.Int32 get_val(System.Int64 loc_id, string name, IntPtr buf, System.IntPtr size, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier.
System.String	name	Link whose value is to be returned.
IntPtr	buf	The buffer to hold the returned link value.
System.IntPtr	size	Maximum number of characters of link value to be returned.
System.Int64	lapl_id	List access property list identifier.

Returns

Type	Description
System.Int32	Returns a non-negative value, with the link value in `buf`, if successful. Otherwise returns a negative value.

Remarks

ASCII strings ONLY!

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

Retrieves value of the nth link in a group, according to the order within an index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetValByIdx

Declaration

public static System.Int32 get_val_by_idx(System.Int64 loc_id, byte[] group_name, H5.index_t idx_type, H5.iter_order_t order, System.UInt64 n, IntPtr buf, System.IntPtr size, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier specifying location of subject group
System.Byte[]	group_name	Name of subject group
H5.index_t	idx_type	Type of index
H5.iter_order_t	order	Order within field or index
System.UInt64	n	Link for which to retrieve information
IntPtr	buf	Pointer to buffer in which link value is returned
System.IntPtr	size	Size in bytes of `group_name`
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_val_by_idx(System.Int64, String, H5.index_t, H5.iter_order_t, System.UInt64, IntPtr, System.IntPtr, System.Int64)

Retrieves value of the nth link in a group, according to the order within an index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-GetValByIdx

Declaration

public static System.Int32 get_val_by_idx(System.Int64 loc_id, string group_name, H5.index_t idx_type, H5.iter_order_t order, System.UInt64 n, IntPtr buf, System.IntPtr size, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier specifying location of subject group
System.String	group_name	Name of subject group
H5.index_t	idx_type	Type of index
H5.iter_order_t	order	Order within field or index
System.UInt64	n	Link for which to retrieve information
IntPtr	buf	Pointer to buffer in which link value is returned
System.IntPtr	size	Size in bytes of `group_name`
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!

is_registered(H5L.type_t)

Determines whether a class of user-defined links is registered. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-IsRegistered

Declaration

public static System.Int32 is_registered(H5L.type_t id)

Parameters

Type	Name	Description
H5L.type_t	id	User-defined link class identifier

Returns

Type	Description
System.Int32	Returns a positive value if the link class has been registered and zero if it is unregistered. Otherwise returns a negative value; this may mean that the identifier is not a valid user-defined class identifier.

iterate(System.Int64, H5.index_t, H5.iter_order_t, ref System.UInt64, H5L.iterate_t, IntPtr)

Iterates through links in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Iterate

Declaration

public static System.Int32 iterate(System.Int64 grp_id, H5.index_t idx_type, H5.iter_order_t order, ref System.UInt64 idx, H5L.iterate_t op, IntPtr op_data)

Parameters

Type	Name	Description
System.Int64	grp_id	Identifier specifying subject group
H5.index_t	idx_type	Type of index which determines the order
H5.iter_order_t	order	Order within index
System.UInt64	idx	Iteration position at which to start
H5L.iterate_t	op	Callback function passing data regarding the link to the calling application
IntPtr	op_data	User-defined pointer to data required by the application for its processing of the link

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.

iterate_by_name(System.Int64, Byte[], H5.index_t, H5.iter_order_t, ref System.UInt64, H5L.iterate_t, IntPtr, System.Int64)

Iterates through links in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-IterateByName

Declaration

public static System.Int32 iterate_by_name(System.Int64 loc_id, byte[] group_name, H5.index_t idx_type, H5.iter_order_t order, ref System.UInt64 idx, H5L.iterate_t op, IntPtr op_data, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier specifying location of subject group
System.Byte[]	group_name	Name of subject group
H5.index_t	idx_type	Type of index which determines the order
H5.iter_order_t	order	Order within index
System.UInt64	idx	Iteration position at which to start
H5L.iterate_t	op	Callback function passing data regarding the link to the calling application
IntPtr	op_data	User-defined pointer to data required by the application for its processing of the link
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.

iterate_by_name(System.Int64, String, H5.index_t, H5.iter_order_t, ref System.UInt64, H5L.iterate_t, IntPtr, System.Int64)

Iterates through links in a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-IterateByName

Declaration

public static System.Int32 iterate_by_name(System.Int64 loc_id, string group_name, H5.index_t idx_type, H5.iter_order_t order, ref System.UInt64 idx, H5L.iterate_t op, IntPtr op_data, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier specifying location of subject group
System.String	group_name	Name of subject group
H5.index_t	idx_type	Type of index which determines the order
H5.iter_order_t	order	Order within index
System.UInt64	idx	Iteration position at which to start
H5L.iterate_t	op	Callback function passing data regarding the link to the calling application
IntPtr	op_data	User-defined pointer to data required by the application for its processing of the link
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!

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

Moves a link within an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Move

Declaration

public static System.Int32 move(System.Int64 src_loc, byte[] src_name, System.Int64 dst_loc, byte[] dst_name, System.Int64 lcpl_id = null, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	src_loc	Original file or group identifier.
System.Byte[]	src_name	Original link name.
System.Int64	dst_loc	Destination file or group identifier.
System.Byte[]	dst_name	New link name.
System.Int64	lcpl_id	Link creation property list identifier to be associated with the new link.
System.Int64	lapl_id	Link access property list identifier to be associated with the new link.

Returns

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

move(System.Int64, String, System.Int64, String, System.Int64, System.Int64)

Moves a link within an HDF5 file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Move

Declaration

public static System.Int32 move(System.Int64 src_loc, string src_name, System.Int64 dst_loc, string dst_name, System.Int64 lcpl_id = null, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	src_loc	Original file or group identifier.
System.String	src_name	Original link name.
System.Int64	dst_loc	Destination file or group identifier.
System.String	dst_name	New link name.
System.Int64	lcpl_id	Link creation property list identifier to be associated with the new link.
System.Int64	lapl_id	Link access property list identifier to be associated with the new link.

Returns

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

Remarks

ASCII strings ONLY!

register(ref H5L.class_t)

Registers a user-defined link class or changes behavior of an existing class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Register

Declaration

public static System.Int32 register(ref H5L.class_t cls)

Parameters

Type	Name	Description
H5L.class_t	cls	Pointer to a buffer containing the struct describing the user-defined link class

Returns

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

unpack_elink_val(IntPtr, System.IntPtr, ref UInt32, ref IntPtr, ref IntPtr)

Decodes external link information. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-UnpackELinkVal

Declaration

public static System.Int32 unpack_elink_val(IntPtr ext_linkval, System.IntPtr link_size, ref uint flags, ref IntPtr filename, ref IntPtr obj_path)

Parameters

Type	Name	Description
IntPtr	ext_linkval	Buffer containing external link information
System.IntPtr	link_size	Size, in bytes, of the `ext_linkval` buffer
System.UInt32	flags	External link flags, packed as a bitmap
IntPtr	filename	Returned filename
IntPtr	obj_path	Returned object path, relative to `filename`

Returns

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

unregister(H5L.type_t)

Unregisters a class of user-defined links. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Unregister

Declaration

public static System.Int32 unregister(H5L.type_t id)

Parameters

Type	Name	Description
H5L.type_t	id	User-defined link class identifier

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, H5L.iterate_t, IntPtr)

Recursively visits all links starting from a specified group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-Visit

Declaration

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

Parameters

Type	Name	Description
System.Int64	grp_id	Identifier of the group 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
H5L.iterate_t	op	Callback function passing data regarding the link to the calling application
IntPtr	op_data	User-defined pointer to data required by the application for its processing of the link

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, H5L.iterate_t, IntPtr, System.Int64)

Recursively visits all links starting from a specified group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-VisitByName

Declaration

public static System.Int32 visit_by_name(System.Int64 loc_id, byte[] group_name, H5.index_t idx_type, H5.iter_order_t order, H5L.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[]	group_name	Name of the group, 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
H5L.iterate_t	op	Callback function passing data regarding the link to the calling application
IntPtr	op_data	User-defined pointer to data required by the application for its processing of the link
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, H5L.iterate_t, IntPtr, System.Int64)

Recursively visits all links starting from a specified group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5L.html#Link-VisitByName

Declaration

public static System.Int32 visit_by_name(System.Int64 loc_id, string group_name, H5.index_t idx_type, H5.iter_order_t order, H5L.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	group_name	Name of the group, 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
H5L.iterate_t	op	Callback function passing data regarding the link to the calling application
IntPtr	op_data	User-defined pointer to data required by the application for its processing of the link
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.

Remarks

ASCII strings ONLY!