Class H5A
Inheritance
Namespace: HDF.PInvoke
Assembly: HDF.PInvoke.dll
Syntax
public sealed class H5A : objectMethods
close(System.Int64)
Closes the specified attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Close
Declaration
public static System.Int32 close(System.Int64 attr_id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | attr_id | Attribute to release access to. |
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, System.Int64)
Creates an attribute attached to a specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Create2
Declaration
public static System.Int64 create(System.Int64 loc_id, byte[] attr_name, System.Int64 type_id, System.Int64 space_id, System.Int64 acpl_id = null, System.Int64 aapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location or object identifier |
| System.Byte[] | attr_name | Attribute name |
| System.Int64 | type_id | Attribute datatype identifier |
| System.Int64 | space_id | Attribute dataspace identifier |
| System.Int64 | acpl_id | Attribute creation property list identifier |
| System.Int64 | aapl_id | Attribute access property list identifier |
Returns
| Type | Description |
|---|---|
| System.Int64 | Returns an attribute identifier if successful; otherwise returns a negative value. |
create(System.Int64, String, System.Int64, System.Int64, System.Int64, System.Int64)
Creates an attribute attached to a specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Create2
Declaration
public static System.Int64 create(System.Int64 loc_id, string attr_name, System.Int64 type_id, System.Int64 space_id, System.Int64 acpl_id = null, System.Int64 aapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location or object identifier |
| System.String | attr_name | Attribute name |
| System.Int64 | type_id | Attribute datatype identifier |
| System.Int64 | space_id | Attribute dataspace identifier |
| System.Int64 | acpl_id | Attribute creation property list identifier |
| System.Int64 | aapl_id | Attribute access property list identifier |
Returns
| Type | Description |
|---|---|
| System.Int64 | Returns an attribute identifier if successful; otherwise returns a negative value. |
Remarks
ASCII strings ONLY!
create_by_name(System.Int64, Byte[], Byte[], System.Int64, System.Int64, System.Int64, System.Int64, System.Int64)
Creates an attribute attached to a specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-CreateByName
Declaration
public static System.Int64 create_by_name(System.Int64 loc_id, byte[] obj_name, byte[] attr_name, System.Int64 type_id, System.Int64 space_id, System.Int64 acpl_id = null, System.Int64 aapl_id = null, System.Int64 lapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location or object identifier; may be dataset or group |
| System.Byte[] | obj_name | Name, relative to |
| System.Byte[] | attr_name | Attribute name |
| System.Int64 | type_id | Attribute datatype identifier |
| System.Int64 | space_id | Attribute dataspace identifier |
| System.Int64 | acpl_id | Attribute creation property list identifier |
| System.Int64 | aapl_id | Attribute access property list identifier |
| System.Int64 | lapl_id | Link access property list |
Returns
| Type | Description |
|---|---|
| System.Int64 | Returns an attribute identifier if successful; otherwise returns a negative value. |
create_by_name(System.Int64, String, String, System.Int64, System.Int64, System.Int64, System.Int64, System.Int64)
Creates an attribute attached to a specified object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-CreateByName
Declaration
public static System.Int64 create_by_name(System.Int64 loc_id, string obj_name, string attr_name, System.Int64 type_id, System.Int64 space_id, System.Int64 acpl_id = null, System.Int64 aapl_id = null, System.Int64 lapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location or object identifier; may be dataset or group |
| System.String | obj_name | Name, relative to |
| System.String | attr_name | Attribute name |
| System.Int64 | type_id | Attribute datatype identifier |
| System.Int64 | space_id | Attribute dataspace identifier |
| System.Int64 | acpl_id | Attribute creation property list identifier |
| System.Int64 | aapl_id | Attribute access property list identifier |
| System.Int64 | lapl_id | Link access property list |
Returns
| Type | Description |
|---|---|
| System.Int64 | Returns an attribute identifier if successful; otherwise returns a negative value. |
Remarks
ASCII strings ONLY!
delete(System.Int64, Byte[])
Deletes an attribute from a specified location. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Delete
Declaration
public static System.Int32 delete(System.Int64 loc_id, byte[] name)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Identifier of the dataset, group, or named datatype to have the attribute deleted from. |
| System.Byte[] | name | Name of the attribute to delete. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns a non-negative value if successful; otherwise returns a negative value. |
delete(System.Int64, String)
Deletes an attribute from a specified location. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Delete
Declaration
public static System.Int32 delete(System.Int64 loc_id, string name)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Identifier of the dataset, group, or named datatype to have the attribute deleted from. |
| System.String | name | Name of the attribute to delete. |
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)
Deletes an attribute from an object according to index order. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-DeleteByIdx
Declaration
public static System.Int32 delete_by_idx(System.Int64 loc_id, byte[] obj_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 | Location or object identifier; may be dataset or group |
| System.Byte[] | obj_name | Name of object, relative to location, from which attribute is to be removed |
| H5.index_t | idx_type | Type of index |
| H5.iter_order_t | order | Order in which to iterate over index |
| System.UInt64 | n | Offset within index |
| 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)
Deletes an attribute from an object according to index order. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-DeleteByIdx
Declaration
public static System.Int32 delete_by_idx(System.Int64 loc_id, string obj_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 | Location or object identifier; may be dataset or group |
| System.String | obj_name | Name of object, relative to location, from which attribute is to be removed |
| H5.index_t | idx_type | Type of index |
| H5.iter_order_t | order | Order in which to iterate over index |
| System.UInt64 | n | Offset within index |
| 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!
delete_by_name(System.Int64, Byte[], Byte[], System.Int64)
Removes an attribute from a specified location. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-DeleteByName
Declaration
public static System.Int32 delete_by_name(System.Int64 loc_id, byte[] obj_name, byte[] attr_name, System.Int64 lapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location or object identifier; may be dataset or group |
| System.Byte[] | obj_name | Name of object, relative to location, from which attribute is to be removed |
| System.Byte[] | attr_name | Name of attribute to delete |
| 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_name(System.Int64, String, String, System.Int64)
Removes an attribute from a specified location. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-DeleteByName
Declaration
public static System.Int32 delete_by_name(System.Int64 loc_id, string obj_name, string attr_name, System.Int64 lapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location or object identifier; may be dataset or group |
| System.String | obj_name | Name of object, relative to location, from which attribute is to be removed |
| System.String | attr_name | Name of attribute to delete |
| 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[])
Determines whether an attribute with a given name exists on an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Exists
Declaration
public static System.Int32 exists(System.Int64 obj_id, byte[] attr_name)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | obj_id | Object identifier |
| System.Byte[] | attr_name | Attribute name |
Returns
| Type | Description |
|---|---|
| System.Int32 | When successful, returns a positive value, for returns a negative value. |
exists(System.Int64, String)
Determines whether an attribute with a given name exists on an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Exists
Declaration
public static System.Int32 exists(System.Int64 obj_id, string attr_name)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | obj_id | Object identifier |
| System.String | attr_name | Attribute name |
Returns
| Type | Description |
|---|---|
| System.Int32 | When successful, returns a positive value, for returns a negative value. |
Remarks
ASCII strings ONLY!
exists_by_name(System.Int64, Byte[], Byte[], System.Int64)
Determines whether an attribute with a given name exists on an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-ExistsByName
Declaration
public static System.Int32 exists_by_name(System.Int64 loc_id, byte[] obj_name, byte[] attr_name, System.Int64 lapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location identifier |
| System.Byte[] | obj_name | Object name |
| System.Byte[] | attr_name | Attribute name |
| System.Int64 | lapl_id | Link access property list identifier |
Returns
| Type | Description |
|---|---|
| System.Int32 | When successful, returns a positive value, for returns a negative value. |
exists_by_name(System.Int64, String, String, System.Int64)
Determines whether an attribute with a given name exists on an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-ExistsByName
Declaration
public static System.Int32 exists_by_name(System.Int64 loc_id, string obj_name, string attr_name, System.Int64 lapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location identifier |
| System.String | obj_name | Object name |
| System.String | attr_name | Attribute name |
| System.Int64 | lapl_id | Link access property list identifier |
Returns
| Type | Description |
|---|---|
| System.Int32 | When successful, returns a positive value, for returns a negative value. |
Remarks
ANSI strings ONLY!
get_create_plist(System.Int64)
Gets an attribute creation property list identifier. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetCreatePlist
Declaration
public static System.Int64 get_create_plist(System.Int64 attr_id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | attr_id | Identifier of the attribute. |
Returns
| Type | Description |
|---|---|
| System.Int64 | Returns an identifier for the attribute’s creation property list if successful. Otherwise returns a negative value. |
get_info(System.Int64, ref H5A.info_t)
Retrieves attribute information, by attribute identifier. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetInfo
Declaration
public static System.Int32 get_info(System.Int64 attr_id, ref H5A.info_t ainfo)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | attr_id | Attribute identifier |
| H5A.info_t | ainfo | Attribute information struct |
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 H5A.info_t, System.Int64)
Retrieves attribute information, by attribute index position. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetInfoByIdx
Declaration
public static System.Int32 get_info_by_idx(System.Int64 loc_id, byte[] obj_name, H5.index_t idx_type, H5.iter_order_t order, System.UInt64 n, ref H5A.info_t ainfo, System.Int64 lapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location of object to which attribute is attached |
| System.Byte[] | obj_name | Name of object to which attribute is attached, relative to location |
| H5.index_t | idx_type | Type of index |
| H5.iter_order_t | order | Index traversal order |
| System.UInt64 | n | Attribute’s position in index |
| H5A.info_t | ainfo | Struct containing returned attribute 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 H5A.info_t, System.Int64)
Retrieves attribute information, by attribute index position. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetInfoByIdx
Declaration
public static System.Int32 get_info_by_idx(System.Int64 loc_id, string obj_name, H5.index_t idx_type, H5.iter_order_t order, System.UInt64 n, ref H5A.info_t ainfo, System.Int64 lapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location of object to which attribute is attached |
| System.String | obj_name | Name of object to which attribute is attached, relative to location |
| H5.index_t | idx_type | Type of index |
| H5.iter_order_t | order | Index traversal order |
| System.UInt64 | n | Attribute’s position in index |
| H5A.info_t | ainfo | Struct containing returned attribute 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[], Byte[], ref H5A.info_t, System.Int64)
Retrieves attribute information, by attribute name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetInfoByName
Declaration
public static System.Int32 get_info_by_name(System.Int64 loc_id, byte[] obj_name, byte[] attr_name, ref H5A.info_t ainfo, System.Int64 lapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location of object to which attribute is attached |
| System.Byte[] | obj_name | Name of object to which attribute is attached, relative to location |
| System.Byte[] | attr_name | Attribute name |
| H5A.info_t | ainfo | Struct containing returned attribute 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, String, ref H5A.info_t, System.Int64)
Retrieves attribute information, by attribute name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetInfoByName
Declaration
public static System.Int32 get_info_by_name(System.Int64 loc_id, string obj_name, string attr_name, ref H5A.info_t ainfo, System.Int64 lapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location of object to which attribute is attached |
| System.String | obj_name | Name of object to which attribute is attached, relative to location |
| System.String | attr_name | Attribute name |
| H5A.info_t | ainfo | Struct containing returned attribute 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_name(System.Int64, System.IntPtr, StringBuilder)
Gets an attribute name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetName
Declaration
public static System.IntPtr get_name(System.Int64 attr_id, System.IntPtr size, StringBuilder name)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | attr_id | Identifier of the attribute. |
| System.IntPtr | size | The size of the buffer to store the name in. |
| StringBuilder | name | Buffer to store name in. |
Returns
| Type | Description |
|---|---|
| System.IntPtr | Returns the length of the attribute's name, which may be longer than |
Remarks
ASCII strings ONLY!
get_name(System.Int64, System.IntPtr, Byte[])
Gets an attribute name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetName
Declaration
public static System.IntPtr get_name(System.Int64 attr_id, System.IntPtr size, byte[] name)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | attr_id | Identifier of the attribute. |
| System.IntPtr | size | The size of the buffer to store the name in. |
| System.Byte[] | name | Buffer to store name in. |
Returns
| Type | Description |
|---|---|
| System.IntPtr | Returns the length of the attribute's name, which may be longer than |
get_name_by_idx(System.Int64, Byte[], H5.index_t, H5.iter_order_t, System.UInt64, Byte[], System.IntPtr, System.Int64)
Gets an attribute name, by attribute index position. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetNameByIdx
Declaration
public static System.IntPtr get_name_by_idx(System.Int64 loc_id, byte[] obj_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 | Location of object to which attribute is attached |
| System.Byte[] | obj_name | Name of object to which attribute is attached, relative to location |
| H5.index_t | idx_type | Type of index |
| H5.iter_order_t | order | Index traversal order |
| System.UInt64 | n | Attribute’s position in index |
| System.Byte[] | name | Attribute name |
| System.IntPtr | size | Size, in bytes, of attribute name |
| System.Int64 | lapl_id | Link access property list |
Returns
| Type | Description |
|---|---|
| System.IntPtr | Returns attribute name size, in bytes, 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)
Gets an attribute name, by attribute index position. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetNameByIdx
Declaration
public static System.IntPtr get_name_by_idx(System.Int64 loc_id, string obj_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 | Location of object to which attribute is attached |
| System.String | obj_name | Name of object to which attribute is attached, relative to location |
| H5.index_t | idx_type | Type of index |
| H5.iter_order_t | order | Index traversal order |
| System.UInt64 | n | Attribute’s position in index |
| IntPtr | name | Attribute name |
| System.IntPtr | size | Size, in bytes, of attribute name |
| System.Int64 | lapl_id | Link access property list |
Returns
| Type | Description |
|---|---|
| System.IntPtr | Returns attribute name size, in bytes, 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)
Gets an attribute name, by attribute index position. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetNameByIdx
Declaration
public static System.IntPtr get_name_by_idx(System.Int64 loc_id, string obj_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 | Location of object to which attribute is attached |
| System.String | obj_name | Name of object to which attribute is attached, relative to location |
| H5.index_t | idx_type | Type of index |
| H5.iter_order_t | order | Index traversal order |
| System.UInt64 | n | Attribute’s position in index |
| StringBuilder | name | Attribute name |
| System.IntPtr | size | Size, in bytes, of attribute name |
| System.Int64 | lapl_id | Link access property list |
Returns
| Type | Description |
|---|---|
| System.IntPtr | Returns attribute name size, in bytes, if successful; otherwise returns a negative value. |
Remarks
ASCII strings ONLY!
get_space(System.Int64)
Gets a copy of the dataspace for an attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetSpace
Declaration
public static System.Int64 get_space(System.Int64 attr_id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | attr_id | Identifier of an attribute. |
Returns
| Type | Description |
|---|---|
| System.Int64 | Returns attribute dataspace identifier if successful; otherwise returns a negative value. |
get_storage_size(System.Int64)
Returns the amount of storage required for an attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetStorageSize
Declaration
public static System.UInt64 get_storage_size(System.Int64 attr_id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | attr_id | Identifier of the attribute to query. |
Returns
| Type | Description |
|---|---|
| System.UInt64 | Returns the amount of storage size allocated for the attribute; otherwise returns 0 (zero). |
get_type(System.Int64)
Returns the amount of storage required for an attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-GetType
Declaration
public static System.Int64 get_type(System.Int64 attr_id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | attr_id | Identifier of an attribute. |
Returns
| Type | Description |
|---|---|
| System.Int64 | Returns a datatype identifier if successful; otherwise returns a negative value. |
iterate(System.Int64, H5.index_t, H5.iter_order_t, ref System.UInt64, H5A.operator_t, IntPtr)
Calls user-defined function for each attribute on an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Iterate2
Declaration
public static System.Int32 iterate(System.Int64 obj_id, H5.index_t idx_type, H5.iter_order_t order, ref System.UInt64 n, H5A.operator_t op, IntPtr op_data)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | obj_id | Identifier for object to which attributes are attached; may be group, dataset, or named datatype. |
| H5.index_t | idx_type | Type of index |
| H5.iter_order_t | order | Order in which to iterate over index |
| System.UInt64 | n | Initial and returned offset within index |
| H5A.operator_t | op | User-defined function to pass each attribute to |
| IntPtr | op_data | User data to pass through to and to be returned by iterator operator function |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns a non-negative value if successful; otherwise returns a negative value. Further note that this function returns the return value of the last operator if it was non-zero, which can be a negative value, zero if all attributes were processed, or a positive value indicating short-circuit success |
iterate_by_name(System.Int64, Byte[], H5.index_t, H5.iter_order_t, ref System.UInt64, H5A.operator_t, IntPtr, System.Int64)
Calls user-defined function for each attribute on an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-IterateByName
Declaration
public static System.Int32 iterate_by_name(System.Int64 loc_id, byte[] obj_name, H5.index_t idx_type, H5.iter_order_t order, ref System.UInt64 n, H5A.operator_t op, IntPtr op_data, System.Int64 lapd_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location or object identifier; may be dataset or group |
| System.Byte[] | obj_name | Name of object, relative to location |
| H5.index_t | idx_type | Type of index |
| H5.iter_order_t | order | Order in which to iterate over index |
| System.UInt64 | n | Initial and returned offset within index |
| H5A.operator_t | op | User-defined function to pass each attribute to |
| IntPtr | op_data | User data to pass through to and to be returned by iterator operator function |
| System.Int64 | lapd_id | Link access property list |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns a non-negative value if successful; otherwise returns a negative value. Further note that this function returns the return value of the last operator if it was non-zero, which can be a negative value, zero if all attributes were processed, or a positive value indicating short-circuit success |
iterate_by_name(System.Int64, String, H5.index_t, H5.iter_order_t, ref System.UInt64, H5A.operator_t, IntPtr, System.Int64)
Calls user-defined function for each attribute on an object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-IterateByName
Declaration
public static System.Int32 iterate_by_name(System.Int64 loc_id, string obj_name, H5.index_t idx_type, H5.iter_order_t order, ref System.UInt64 n, H5A.operator_t op, IntPtr op_data, System.Int64 lapd_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location or object identifier; may be dataset or group |
| System.String | obj_name | Name of object, relative to location |
| H5.index_t | idx_type | Type of index |
| H5.iter_order_t | order | Order in which to iterate over index |
| System.UInt64 | n | Initial and returned offset within index |
| H5A.operator_t | op | User-defined function to pass each attribute to |
| IntPtr | op_data | User data to pass through to and to be returned by iterator operator function |
| System.Int64 | lapd_id | Link access property list |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns a non-negative value if successful; otherwise returns a negative value. Further note that this function returns the return value of the last operator if it was non-zero, which can be a negative value, zero if all attributes were processed, or a positive value indicating short-circuit success |
Remarks
ANSI strings ONLY!
open(System.Int64, Byte[], System.Int64)
Opens an attribute for an object specified by object identifier and attribute name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Open
Declaration
public static System.Int64 open(System.Int64 obj_id, byte[] attr_name, System.Int64 aapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | obj_id | Identifer for object to which attribute is attached |
| System.Byte[] | attr_name | Name of attribute to open |
| System.Int64 | aapl_id | Attribute access property list |
Returns
| Type | Description |
|---|---|
| System.Int64 | Returns an attribute identifier if successful; otherwise returns a negative value. |
open(System.Int64, String, System.Int64)
Opens an attribute for an object specified by object identifier and attribute name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Open
Declaration
public static System.Int64 open(System.Int64 obj_id, string attr_name, System.Int64 aapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | obj_id | Identifer for object to which attribute is attached |
| System.String | attr_name | Name of attribute to open |
| System.Int64 | aapl_id | Attribute access property list |
Returns
| Type | Description |
|---|---|
| System.Int64 | Returns an attribute identifier if successful; otherwise returns a negative value. |
Remarks
ASCII strings ONLY!
open_by_idx(System.Int64, Byte[], H5.index_t, H5.iter_order_t, System.UInt64, System.Int64, System.Int64)
Opens an attribute for an object specified by attribute index position. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-OpenByIdx
Declaration
public static System.Int64 open_by_idx(System.Int64 loc_id, byte[] obj_name, H5.index_t idx_type, H5.iter_order_t order, System.UInt64 n, System.Int64 aapl_id = null, System.Int64 lapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location of object to which attribute is attached |
| System.Byte[] | obj_name | Name of object to which attribute is attached, relative to location |
| H5.index_t | idx_type | Type of index |
| H5.iter_order_t | order | Index traversal order |
| System.UInt64 | n | Attribute’s position in index |
| System.Int64 | aapl_id | Attribute access property list |
| System.Int64 | lapl_id | Link access property list |
Returns
| Type | Description |
|---|---|
| System.Int64 | Returns an attribute identifier if successful; otherwise returns a negative value. |
open_by_idx(System.Int64, String, H5.index_t, H5.iter_order_t, System.UInt64, System.Int64, System.Int64)
Opens an attribute for an object specified by attribute index position. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-OpenByIdx
Declaration
public static System.Int64 open_by_idx(System.Int64 loc_id, string obj_name, H5.index_t idx_type, H5.iter_order_t order, System.UInt64 n, System.Int64 aapl_id = null, System.Int64 lapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location of object to which attribute is attached |
| System.String | obj_name | Name of object to which attribute is attached, relative to location |
| H5.index_t | idx_type | Type of index |
| H5.iter_order_t | order | Index traversal order |
| System.UInt64 | n | Attribute’s position in index |
| System.Int64 | aapl_id | Attribute access property list |
| System.Int64 | lapl_id | Link access property list |
Returns
| Type | Description |
|---|---|
| System.Int64 | Returns an attribute identifier if successful; otherwise returns a negative value. |
Remarks
ASCII strings ONLY!
open_by_name(System.Int64, Byte[], Byte[], System.Int64, System.Int64)
Opens an attribute for an object by object name and attribute name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-OpenByName
Declaration
public static System.Int64 open_by_name(System.Int64 loc_id, byte[] obj_name, byte[] attr_name, System.Int64 aapl_id = null, System.Int64 lapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location from which to find object to which attribute is attached |
| System.Byte[] | obj_name | Name of object to which attribute is
attached, relative to |
| System.Byte[] | attr_name | Name of attribute to open |
| System.Int64 | aapl_id | Attribute access property list |
| System.Int64 | lapl_id | Link access property list |
Returns
| Type | Description |
|---|---|
| System.Int64 | Returns an attribute identifier if successful; otherwise returns a negative value. |
open_by_name(System.Int64, String, String, System.Int64, System.Int64)
Opens an attribute for an object by object name and attribute name. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-OpenByName
Declaration
public static System.Int64 open_by_name(System.Int64 loc_id, string obj_name, string attr_name, System.Int64 aapl_id = null, System.Int64 lapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location from which to find object to which attribute is attached |
| System.String | obj_name | Name of object to which attribute is
attached, relative to |
| System.String | attr_name | Name of attribute to open |
| System.Int64 | aapl_id | Attribute access property list |
| System.Int64 | lapl_id | Link access property list |
Returns
| Type | Description |
|---|---|
| System.Int64 | Returns an attribute identifier if successful; otherwise returns a negative value. |
Remarks
ASCII strings ONLY!
read(System.Int64, System.Int64, IntPtr)
Reads an attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Read
Declaration
public static System.Int32 read(System.Int64 attr_id, System.Int64 type_id, IntPtr buf)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | attr_id | Identifier of an attribute to read. |
| System.Int64 | type_id | Identifier of the attribute datatype (in memory). |
| IntPtr | buf | Buffer for data to be read. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns a non-negative value if successful; otherwise returns a negative value. |
rename(System.Int64, Byte[], Byte[])
Renames an attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Rename
Declaration
public static System.Int32 rename(System.Int64 loc_id, byte[] old_name, byte[] new_name)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location of the attribute. |
| System.Byte[] | old_name | Name of the attribute to be changed. |
| System.Byte[] | new_name | New name for the attribute. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns a non-negative value if successful; otherwise returns a negative value.S |
rename(System.Int64, String, String)
Renames an attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Rename
Declaration
public static System.Int32 rename(System.Int64 loc_id, string old_name, string new_name)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location of the attribute. |
| System.String | old_name | Name of the attribute to be changed. |
| System.String | new_name | New name for the attribute. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns a non-negative value if successful; otherwise returns a negative value. |
Remarks
ASCII strings ONLY!
rename_by_name(System.Int64, Byte[], Byte[], Byte[], System.Int64)
Renames an attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-RenameByName
Declaration
public static System.Int32 rename_by_name(System.Int64 loc_id, byte[] obj_name, byte[] old_attr_name, byte[] new_attr_name, System.Int64 lapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location or object identifier; may be dataset or group |
| System.Byte[] | obj_name | Name of object, relative to location, whose attribute is to be renamed |
| System.Byte[] | old_attr_name | Prior attribute name |
| System.Byte[] | new_attr_name | New attribute name |
| 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. |
rename_by_name(System.Int64, String, String, String, System.Int64)
Renames an attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-RenameByName
Declaration
public static System.Int32 rename_by_name(System.Int64 loc_id, string obj_name, string old_attr_name, string new_attr_name, System.Int64 lapl_id = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | loc_id | Location or object identifier; may be dataset or group |
| System.String | obj_name | Name of object, relative to location, whose attribute is to be renamed |
| System.String | old_attr_name | Prior attribute name |
| System.String | new_attr_name | New attribute name |
| 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!
write(System.Int64, System.Int64, IntPtr)
Writes data to an attribute. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-Write
Declaration
public static System.Int32 write(System.Int64 attr_id, System.Int64 mem_type_id, IntPtr buf)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | attr_id | Identifier of an attribute to write. |
| System.Int64 | mem_type_id | Identifier of the attribute datatype (in memory). |
| IntPtr | buf | Data to be written. |
Returns
| Type | Description |
|---|---|
| System.Int32 |