ddn.lib.hdf5.h5a

HDF5 Attribute Binding

This module provides D bindings for HDF5 attribute operations (H5A API).

License

BSD-3-Clause

fn H5Aclose H5Acreate1 H5Acreate2 H5Acreate_by_name H5Adelete H5Adelete_by_idx H5Adelete_by_name H5Aexists H5Aexists_by_name H5Aget_create_plist H5Aget_info H5Aget_info_by_idx H5Aget_info_by_name H5Aget_name H5Aget_name_by_idx H5Aget_num_attrs H5Aget_space H5Aget_storage_size H5Aget_type H5Aiterate1 H5Aiterate2 H5Aiterate_by_name H5Aopen H5Aopen_by_idx H5Aopen_by_name H5Aopen_idx H5Aopen_name H5Aread H5Arename H5Arename_by_name H5Awrite

Types 6

structH5A_info_t

Attribute information structure

Fields

hbool_t corder_valid

ulong corder

H5T_cset_t cset

hsize_t data_size

enumH5T_cset_t : int

Character set type (from H5T)

CSET_ERROR = - 1

ASCII = 0

UTF8 = 1

enumH5_INDEX : int

Index types for iteration.

Specifies the index to use when iterating over attributes or links.

UNKNOWN = - 1Unknown index type

NAME = 0Index by name

CRT_ORDER = 1Index by creation order

N = 2Number of index types (not a valid type)

enumH5_ITER_ORDER : int

Iteration order options.

Specifies the order to use when iterating over attributes or links.

UNKNOWN = - 1Unknown order

INC = 0Increasing order

DEC = 1Decreasing order

NATIVE = 2Native order (fastest)

N = 3Number of iteration orders (not a valid order)

aliasH5A_operator2_t = herr_t function(hid_t location_id, const char * attr_name, const H5A_info_t * ainfo, void * op_data)

Callback function type for H5Aiterate2.

Parameters

`location_id`	Object identifier for the object to which the attribute is attached
`attr_name`	Name of the current attribute
`ainfo`	Pointer to the attribute info structure
`op_data`	User data passed to H5Aiterate2

Returns

Zero to continue iteration, positive to stop iteration successfully,

negative to stop iteration with an error.

aliasH5A_operator1_t = herr_t function(hid_t loc_id, const char * attr_name, void * op_data)

Callback type for H5Aiterate1.

Functions 31

hid_t H5Acreate2(hid_t loc_id,  const  char *  attr_name,  hid_t type_id,  hid_t space_id,
       hid_t acpl_id,  hid_t aapl_id)

Creates an attribute

hid_t H5Acreate_by_name(hid_t loc_id,  const  char *  obj_name,  const  char *  attr_name,
       hid_t type_id,  hid_t space_id,  hid_t acpl_id,  hid_t aapl_id,  hid_t lapl_id)

Creates an attribute by name

fnhid_t H5Aopen(hid_t obj_id, const char * attr_name, hid_t aapl_id)Opens an attribute

hid_t H5Aopen_by_name(hid_t loc_id,  const  char *  obj_name,  const  char *  attr_name,
       hid_t aapl_id,  hid_t lapl_id)

Opens an attribute by name

fnherr_t H5Aclose(hid_t attr_id)Closes an attribute

fnherr_t H5Aread(hid_t attr_id, hid_t type_id, void * buf)Reads attribute data

fnherr_t H5Awrite(hid_t attr_id, hid_t type_id, const void * buf)Writes attribute data

fnhid_t H5Aget_space(hid_t attr_id)Gets attribute dataspace

fnhid_t H5Aget_type(hid_t attr_id)Gets attribute datatype

fnhid_t H5Aget_create_plist(hid_t attr_id)Gets attribute creation property list

fnssize_t H5Aget_name(hid_t attr_id, size_t buf_size, char * buf)Gets attribute name

fnhsize_t H5Aget_storage_size(hid_t attr_id)Gets attribute storage size

fnherr_t H5Aget_info(hid_t attr_id, H5A_info_t * ainfo)Gets attribute information

herr_t H5Aget_info_by_name(hid_t loc_id,  const  char *  obj_name,  const  char *  attr_name,
       H5A_info_t *  ainfo,  hid_t lapl_id)

Gets attribute information by name

fnherr_t H5Adelete(hid_t loc_id, const char * attr_name)Deletes an attribute

fnherr_t H5Adelete_by_name(hid_t loc_id, const char * obj_name, const char * attr_name, hid_t lapl_id)Deletes an attribute by name

fnhtri_t H5Aexists(hid_t obj_id, const char * attr_name)Checks if attribute exists

fnhtri_t H5Aexists_by_name(hid_t obj_id, const char * obj_name, const char * attr_name, hid_t lapl_id)Checks if attribute exists by name

fnherr_t H5Arename(hid_t loc_id, const char * old_name, const char * new_name)Renames an attribute

herr_t H5Arename_by_name(hid_t loc_id,  const  char *  obj_name,  const  char *  old_attr_name,
       const  char *  new_attr_name,  hid_t lapl_id)

Renames an attribute by name

herr_t H5Aiterate2(hid_t obj_id,  int  idx_type,  int  order,  hsize_t *  idx,
       H5A_operator2_t op,  void *  op_data)

Iterates over attributes attached to an object.

herr_t H5Aiterate_by_name(hid_t loc_id,  const  char *  obj_name,  int  idx_type,  int  order,
       hsize_t *  idx,  H5A_operator2_t op,  void *  op_data,  hid_t lapl_id)

Iterates over attributes attached to an object specified by name.

herr_t H5Aget_info_by_idx(hid_t loc_id,  const  char *  obj_name,  int  idx_type,  int  order,
       hsize_t n,  H5A_info_t *  ainfo,  hid_t lapl_id)

Gets attribute information by index.

ssize_t H5Aget_name_by_idx(hid_t loc_id,  const  char *  obj_name,  int  idx_type,  int  order,
       hsize_t n,  char *  name,  size_t size,  hid_t lapl_id)

Gets attribute name by index.

hid_t H5Aopen_by_idx(hid_t loc_id,  const  char *  obj_name,  int  idx_type,  int  order,
       hsize_t n,  hid_t aapl_id,  hid_t lapl_id)

Opens an attribute by index.

herr_t H5Adelete_by_idx(hid_t loc_id,  const  char *  obj_name,  int  idx_type,  int  order,
       hsize_t n,  hid_t lapl_id)

Deletes an attribute by index.

fnint H5Aget_num_attrs(hid_t loc_id)Returns the number of attributes attached to an object.

hid_t H5Acreate1(hid_t loc_id,  const  char *  name,  hid_t type_id,
       hid_t space_id,  hid_t acpl_id)

Creates an attribute (version 1, deprecated).

fnhid_t H5Aopen_name(hid_t loc_id, const char * name)Opens an attribute by name (deprecated).

fnhid_t H5Aopen_idx(hid_t loc_id, uint idx)Opens an attribute by index (deprecated).

fnherr_t H5Aiterate1(hid_t loc_id, uint * idx, H5A_operator1_t op, void * op_data)Iterates over attributes (version 1, deprecated).