Class H5G

Inheritance

System.Object

H5G

Namespace: HDF.PInvoke

Assembly: HDF.PInvoke.dll

Syntax

public sealed class H5G : object

Methods

close(System.Int64)

Closes the specified group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-Close

Declaration

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

Parameters

Type	Name	Description
System.Int64	group_id	Group identifier to release.

Returns

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

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

Creates a new group and links it into the file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-Create2

Declaration

public static System.Int64 create(System.Int64 loc_id, byte[] name, System.Int64 lcpl_id = null, System.Int64 gcpl_id = null, System.Int64 gapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier
System.Byte[]	name	Absolute or relative name of the link to the new group
System.Int64	lcpl_id	Link creation property list identifier
System.Int64	gcpl_id	Group creation property list identifier
System.Int64	gapl_id	Group access property list identifier

Returns

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

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

Creates a new group and links it into the file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-Create2

Declaration

public static System.Int64 create(System.Int64 loc_id, string name, System.Int64 lcpl_id = null, System.Int64 gcpl_id = null, System.Int64 gapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier
System.String	name	Absolute or relative name of the link to the new group
System.Int64	lcpl_id	Link creation property list identifier
System.Int64	gcpl_id	Group creation property list identifier
System.Int64	gapl_id	Group access property list identifier

Returns

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

Remarks

ASCII strings ONLY!

create_anon(System.Int64, System.Int64, System.Int64)

Creates a new empty group without linking it into the file structure. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-CreateAnon

Declaration

public static System.Int64 create_anon(System.Int64 loc_id, System.Int64 gcpl_id = null, System.Int64 gapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier specifying the file in which the new group is to be created
System.Int64	gcpl_id	Group creation property list identifier
System.Int64	gapl_id	Group access property list identifier

Returns

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

flush(System.Int64)

Flushes all buffers associated with a group to disk. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Gflush.htm

Declaration

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

Parameters

Type	Name	Description
System.Int64	group_id	Identifier of the group to be flushed.

Returns

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

get_create_plist(System.Int64)

Gets a group creation property list identifier. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-GetCreatePlist

Declaration

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

Parameters

Type	Name	Description
System.Int64	group_id	Identifier of the group.

Returns

Type	Description
System.Int64	Returns an identifier for the group’s creation property list if successful. Otherwise returns a negative value.

get_info(System.Int64, ref H5G.info_t)

Retrieves information about a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-GetInfo

Declaration

public static System.Int32 get_info(System.Int64 loc_id, ref H5G.info_t ginfo)

Parameters

Type	Name	Description
System.Int64	loc_id	Group identifier
H5G.info_t	ginfo	Struct in which group information is returned

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 H5G.info_t, System.Int64)

Retrieves information about a group, according to the group’s position within an index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-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 H5G.info_t ginfo, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier
System.Byte[]	group_name	Name of group containing group for which information is to be retrieved
H5.index_t	idx_type	Index type
H5.iter_order_t	order	Order of the count in the index
System.UInt64	n	Position in the index of the group for which information is retrieved
H5G.info_t	ginfo	Struct in which group information 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 H5G.info_t, System.Int64)

Retrieves information about a group, according to the group’s position within an index. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-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 H5G.info_t ginfo, System.Int64 lapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier
System.String	group_name	Name of group containing group for which information is to be retrieved
H5.index_t	idx_type	Index type
H5.iter_order_t	order	Order of the count in the index
System.UInt64	n	Position in the index of the group for which information is retrieved
H5G.info_t	ginfo	Struct in which group information 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_info_by_name(System.Int64, Byte[], ref H5G.info_t, System.Int64)

Retrieves information about a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-GetInfoByName

Declaration

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

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier
System.Byte[]	name	Name of group for which information is to be retrieved
H5G.info_t	ginfo	Struct in which group information 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_name(System.Int64, String, ref H5G.info_t, System.Int64)

Retrieves information about a group. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-GetInfoByName

Declaration

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

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier
System.String	name	Name of group for which information is to be retrieved
H5G.info_t	ginfo	Struct in which group information 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 strngs ONLY!

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

Opens an existing group with a group access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-Open2

Declaration

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

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier specifying the location of the group to be opened
System.Byte[]	name	Name of the group to open
System.Int64	gapl_id	Group access property list identifier

Returns

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

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

Opens an existing group with a group access property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5G.html#Group-Open2

Declaration

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

Parameters

Type	Name	Description
System.Int64	loc_id	File or group identifier specifying the location of the group to be opened
System.String	name	Name of the group to open
System.Int64	gapl_id	Group access property list identifier

Returns

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

Remarks

ASCII strings ONLY!

refresh(System.Int64)

Refreshes all buffers associated with a group. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Grefresh.htm

Declaration

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

Parameters

Type	Name	Description
System.Int64	group_id	Identifier of the group to be refreshed.

Returns

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