iufCompoundFile.c File Reference

#include <stdlib.h>
#include <string.h>
#include <iuf.h>
#include <iufCompoundFile.h>
#include <iufCompoundFileStructure.h>
#include <iufCompoundFileInstance.h>
#include <iufDataStream.h>
#include <iufHistoryNodePrivate.h>

Data Structures
struct	IufCompoundFileInstance
struct	IufCompoundFile

Functions
iucfi_t	iufCompoundFileInstanceCreate (void)
int	iufCompoundFileInstanceDelete (iucfi_t instance)
int	iufCompoundFileDelete (iuif_t compoundFile)
iucf_t	iufCompoundFileCreate (const char *filename)
	Create an empty file instance with a filename. More...
void *	iufCompoundFileInstanceLoad (hid_t handle)
iuhn_t	iufCompoundFileLoadNode (hid_t handle)
iucf_t	iufCompoundFileNodeLoad (const char *pFilename)
	Load an inputFile instance from a file. More...
int	iufCompoundFileSaveInstance (hid_t handle, iucfi_t instanceData)
int	iufCompoundFileNodeSave (iuif_t compoundFile)
int	iufCompoundFileClose (iuif_t compoundFile)
int	iufCompoundFileCompare (iucf_t reference, iucf_t actual)
	Compares two inputFile instances with each other. More...
int	iufCompoundFileSetFilename (iuif_t compoundFile, char *fileName)

---

Data Structure Documentation

IufCompoundFileInstance

struct IufCompoundFileInstance

Data Fields
iuds_t	dataStream	Contains dataset administration
IUF_BOOL	deepDelete
iufl_t	frameList
hid_t	handle	HDF5 file handle
int	IufVersion	The version of input file format
const char *	pFilename	the filename

IufCompoundFile

struct IufCompoundFile

Data Fields
iuhn_t	history

Function Documentation

iufCompoundFileClose()

int iufCompoundFileClose

(

iuif_t

compoundFile

)

iufCompoundFileCompare()

int iufCompoundFileCompare	(	iucf_t	reference,
		iucf_t	actual
	)

Compares two inputFile instances with each other.

Returns

Returns IUF_TRUE when the inputFiles are equal and IUF_FALSE otherwise.

Parameters

reference	The IufCompoundFile to compare to
actual	The IufCompoundFile to compare with

iufCompoundFileCreate()

iucf_t iufCompoundFileCreate

(

const char *

filename

)

Create an empty file instance with a filename.

Returns

Returns the empty file instance when succesful or IUCF_INVALID in case of an error.

Parameters

filename

The filename for the file instance.

iufCompoundFileDelete()

int iufCompoundFileDelete

(

iuif_t

compoundFile

)

iufCompoundFileInstanceCreate()

iucfi_t iufCompoundFileInstanceCreate

(

void

)

iufCompoundFileInstanceDelete()

int iufCompoundFileInstanceDelete

(

iucfi_t

instance

)

iufCompoundFileInstanceLoad()

void* iufCompoundFileInstanceLoad

(

hid_t

handle

)

iufCompoundFileLoadNode()

iuhn_t iufCompoundFileLoadNode

(

hid_t

handle

)

iufCompoundFileNodeLoad()

iucf_t iufCompoundFileNodeLoad

(

const char *

pFilename

)

Load an inputFile instance from a file.

Returns

Returns an input file instance or IUIF_INVALID the file could not be read.

Parameters

pFilename

The filename of the inputFile

iufCompoundFileNodeSave()

int iufCompoundFileNodeSave

(

iuif_t

compoundFile

)

iufCompoundFileSaveInstance()

int iufCompoundFileSaveInstance	(	hid_t	handle,
		iucfi_t	instanceData
	)

iufCompoundFileSetFilename()

int iufCompoundFileSetFilename	(	iuif_t	compoundFile,
		char *	fileName
	)