Class H5R

Inheritance

System.Object

H5R

Namespace: HDF.PInvoke

Assembly: HDF.PInvoke.dll

Syntax

public sealed class H5R : object

Fields

DSET_REG_REF_BUF_SIZE

Declaration

public const int DSET_REG_REF_BUF_SIZE = null

Field Value

Type	Description
System.Int32

OBJ_REF_BUF_SIZE

Declaration

public const int OBJ_REF_BUF_SIZE = null

Field Value

Type	Description
System.Int32

Methods

create(IntPtr, System.Int64, Byte[], H5R.type_t, System.Int64)

Creates a reference. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5R.html#Reference-Create

Declaration

public static System.Int32 create(IntPtr refer, System.Int64 loc_id, byte[] name, H5R.type_t ref_type, System.Int64 space_id)

Parameters

Type	Name	Description
IntPtr	refer	Reference created by the function call.
System.Int64	loc_id	Location identifier used to locate the object being pointed to.
System.Byte[]	name	Name of object at location loc_id.
H5R.type_t	ref_type	Type of reference.
System.Int64	space_id	Dataspace identifier with selection. Used only for dataset region references; pass as -1 if reference is an object reference.

Returns

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

create(IntPtr, System.Int64, String, H5R.type_t, System.Int64)

Creates a reference. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5R.html#Reference-Create

Declaration

public static System.Int32 create(IntPtr refer, System.Int64 loc_id, string name, H5R.type_t ref_type, System.Int64 space_id)

Parameters

Type	Name	Description
IntPtr	refer	Reference created by the function call.
System.Int64	loc_id	Location identifier used to locate the object being pointed to.
System.String	name	Name of object at location loc_id.
H5R.type_t	ref_type	Type of reference.
System.Int64	space_id	Dataspace identifier with selection. Used only for dataset region references; pass as -1 if reference is an object reference.

Returns

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

Remarks

ASCII strings ONLY!

dereference(System.Int64, System.Int64, H5R.type_t, IntPtr)

Opens the HDF5 object referenced.

Declaration

public static System.Int64 dereference(System.Int64 obj_id, System.Int64 oapl_id, H5R.type_t ref_type, IntPtr refer)

Parameters

Type	Name	Description
System.Int64	obj_id	Valid identifier for the file containing the referenced object or any object in that file.
System.Int64	oapl_id
H5R.type_t	ref_type	The reference type of refer.
IntPtr	refer	Reference to open.

Returns

Type	Description
System.Int64	Returns identifier of referenced object if successful; otherwise returns a negative value.

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

Retrieves a name for a referenced object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5R.html#Reference-GetName

Declaration

public static System.IntPtr get_name(System.Int64 loc_id, H5R.type_t ref_type, IntPtr refer, StringBuilder name, System.IntPtr size)

Parameters

Type	Name	Description
System.Int64	loc_id	Identifier for the file containing the reference or for any object in that file.
H5R.type_t	ref_type	Type of reference.
IntPtr	refer	An object or dataset region reference.
StringBuilder	name	A buffer to place the name of the referenced object or dataset region. If NULL , then this call will return the size in bytes of the name.
System.IntPtr	size	The size of the name buffer.

Returns

Type	Description
System.IntPtr	Returns the length of the name if successful, returning 0 (zero) if no name is associated with the identifier. Otherwise returns a negative value.

Remarks

ASCII strings ONLY!

get_name(System.Int64, H5R.type_t, IntPtr, Byte[], System.IntPtr)

Retrieves a name for a referenced object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5R.html#Reference-GetName

Declaration

public static System.IntPtr get_name(System.Int64 loc_id, H5R.type_t ref_type, IntPtr refer, byte[] name, System.IntPtr size)

Parameters

Type	Name	Description
System.Int64	loc_id	Identifier for the file containing the reference or for any object in that file.
H5R.type_t	ref_type	Type of reference.
IntPtr	refer	An object or dataset region reference.
System.Byte[]	name	A buffer to place the name of the referenced object or dataset region. If NULL , then this call will return the size in bytes of the name.
System.IntPtr	size	The size of the name buffer.

Returns

Type	Description
System.IntPtr	Returns the length of the name if successful, returning 0 (zero) if no name is associated with the identifier. Otherwise returns a negative value.

get_obj_type(System.Int64, H5R.type_t, IntPtr, ref H5O.type_t)

Retrieves the type of object that an object reference points to. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5R.html#Reference-GetObjType2

Declaration

public static System.Int32 get_obj_type(System.Int64 loc_id, H5R.type_t ref_type, IntPtr refer, ref H5O.type_t obj_type)

Parameters

Type	Name	Description
System.Int64	loc_id	The dataset containing the reference object or the group containing that dataset.
H5R.type_t	ref_type	Type of reference to query.
IntPtr	refer	Reference to query.
H5O.type_t	obj_type	Type of referenced object.

Returns

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

get_region(System.Int64, H5R.type_t, IntPtr)

Sets up a dataspace and selection as specified by a region reference. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5R.html#Reference-GetRegion

Declaration

public static System.Int64 get_region(System.Int64 loc_id, H5R.type_t ref_type, IntPtr refer)

Parameters

Type	Name	Description
System.Int64	loc_id	File identifier or identifier for any object in the file containing the referenced region
H5R.type_t	ref_type	Reference type of refer, which must be DATASET_REGION .
IntPtr	refer	Region reference to open

Returns

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