F5A.h

Go to the documentation of this file.

#ifndef __F5_F5A_H
#define __F5_F5A_H      "Attribute Functions"
 
#include "hdf5inc.h"
 
#include "F5WinDLLApi.h"
 
#ifdef  __cplusplus
extern "C"
{
#endif
 
/** Open some attribute if it exists, otherwise create one. */
F5_API hid_t F5Aappend(hid_t loc_id, const char *name, hid_t type_id, hid_t space_id, hid_t create_plist );
 
/** Try to open an HDF5 attribute, silently return -1 if it does not exist. */
F5_API hid_t F5Atry_to_open(hid_t location, const char*name);
 
/** @ingroup Internal
    Wrap HDF5 call by debug verbosity option.
*/
F5_API hid_t F5Aopen_name(hid_t location, const char*name);
 
/**
   Create a string attribute which is of the size of the given string
   and write it to the file.
 */
F5_API int F5Asave_string(hid_t loc_id, const char*name, const char*buf);
 
F5_API int F5Asave_strings(hid_t loc_id, const char*name, const char*buf, int HowMany);
 
/**
   Get a string attribute from the file.
   If buf is a NULL pointer, then the string is allocated dynamically and
   the caller needs to issue free() on the result.
   If the string could not be read, returns a NULL pointer.
 */
F5_API char*    F5Aget_string(hid_t loc_id, const char*name, char*buf, size_t len);
 
/**
 * Get type of an attribute by name.
 * After calling this function both, attribute and type
 * must be closed, otherwise warnings will occur
 */
 
F5_API hid_t F5Aget_type(hid_t loc_id, const char*name, hid_t* attrib);
 
/*
  Write an attribute to the object loc_id with a version number.
  A version number is built from three integers.
  @param loc_id Any HDF5 object that may carry attributes.
 */
F5_API herr_t F5Asave_version(hid_t loc_id, int major, int minor, int release);
 
/**
 Get version number for given object.
 @param loc_id Any HDF5 object that may carry attributes.
 */
F5_API herr_t   F5Aget_version(hid_t loc_id, int*major, int*minor, int*release);
 
/**
 Get a number of integers from an attribute which is an integer array.
 The specified number n must match exactly with the number of elements.
 @return positive number of elements (n) if success, 0 if attribute not found,
         and the negative number of elements otherwise.
         Success can easily be tested by checking the return value to
         be larger than zero.
 */
F5_API long F5Aget_ints(hid_t loc_id, const char*name, int*data, hsize_t n);
 
/**
   Save an array of integers as an attribute.
   @return non-zero in case of error
 */
F5_API int F5Asave_ints(hid_t loc_id, const char*name, const int data[], hsize_t n);
 
/**
   Save an integer to the file as an attribute, checking if it
   already existed, and if so, that it had the same value.
   @return non-zero in case of error, such as different value in file.
 */
F5_API int F5Astore_integer(hid_t loc_id, const char*name, int data);
 
/**
   Save an integer to the file as an attribute, overwriting
   any existing value.
   @return non-zero in case of error
 */
F5_API int F5Awrite_integer(hid_t loc_id, const char*name, int data);
 
 
F5_API int F5Asave(hid_t loc_id, const char*name, hid_t file_type_id, hid_t mem_type_id, const void*data, hsize_t n);
 
#ifdef  __cplusplus
}    /* extern "C" */
#endif
 
#endif  /* __F5_F5A_H */