BioHDF file manipulation functions and data structures. More...

Typedefs
typedef struct _biohdf_file *	biohdf_file
	A BioHDF file handle.
Functions
BIOHDF_API biohdf_error	BIOHDFcreate_biohdf_file (const char filename, biohdf_file f)
	Create a BioHDF file.
BIOHDF_API biohdf_error	BIOHDFopen_biohdf_file (const char filename, biohdf_open_mode mode, biohdf_file f)
	Open a BioHDF file.
BIOHDF_API biohdf_error	BIOHDFclose_biohdf_file (biohdf_file *f)
	Close a BioHDF file.

Detailed Description

BioHDF file manipulation functions and data structures.

Typedef Documentation

typedef struct _biohdf_file* biohdf_file

A BioHDF file handle.

BIOHDF_API biohdf_error BIOHDFclose_biohdf_file ( biohdf_file * f )

Close a BioHDF file.

This function will set the file handle to NULL after freeing it.

Parameters:

[in,out] f A BioHDF file handle This will be set to NULL.

CHECK*PARAMETERS

CODE

SUCCESS

FAILURE

BIOHDF_API biohdf_error BIOHDFcreate_biohdf_file	(	const char *	filename,
		biohdf_file *	f
	)

Create a BioHDF file.

The file handle returned by this function will be ready to accept I/O.

Parameters:

	filename	The name of the BioHDF file to create.
[out]	f	A BioHDF file handle.

CHECK*PARAMETERS

CODE

SUCCESS

FAILURE

BIOHDF_API biohdf_error BIOHDFopen_biohdf_file	(	const char *	filename,
		biohdf_open_mode	mode,
		biohdf_file *	f
	)

Open a BioHDF file.

Parameters:

	filename	The name of the BioHDF file to open.
	mode	The file access mode (read only \| read/write).
[out]	f	A BioHDF file handle.

CHECK*PARAMETERS

CODE

SUCCESS

FAILURE