iufFile.h File Reference

#include "iufHistoryNode.h"

Go to the source code of this file.

Macros
#define	IUFLIBRARY_IUFFILE_H
#define	IUFI_INVALID   (iuf_t) NULL

Typedefs
typedef IufFile *	iuf_t

Functions
iuf_t	iufFileLoad (char *pFilename)
	Create an IufFile from the file pFilename. More...
int	iufFileDelete (iuf_t file)
	Deletes an IufFile object. returns IUF_E_OK when successful and IUF_ERR_VALUE otherwise. More...
int	iufFileCompare (iuf_t reference, iuf_t actual)
	Compares two IufFile objects with each other. returns IUF_TRUE when the two files are equal and IUF_FALSE otherwise. More...
iuhn_t	iufFileGetHistoryTree (iuf_t file)
	Gets the history node of the IufFile. More...
const char *	iufFileGetType (iuf_t file)
	Gets the type label of the IufFile. More...
int	iufFileSetHistoryTree (iuf_t file, iuhn_t history)
	Sets the IufHistoryNode of the IufFile. More...

Macro Definition Documentation

IUFI_INVALID

#define IUFI_INVALID   (iuf_t) NULL

IUFLIBRARY_IUFFILE_H

#define IUFLIBRARY_IUFFILE_H

Typedef Documentation

iuf_t

typedef IufFile* iuf_t

A iufFile contains the file handle and the history node

Function Documentation

iufFileCompare()

int iufFileCompare	(	iuf_t	reference,
		iuf_t	actual
	)

Compares two IufFile objects with each other. returns IUF_TRUE when the two files are equal and IUF_FALSE otherwise.

Parameters

reference	The IufFile to compare to
actual	The IufFile to compare with

iufFileDelete()

int iufFileDelete

(

iuf_t

file

)

Deletes an IufFile object. returns IUF_E_OK when successful and IUF_ERR_VALUE otherwise.

Parameters

file	The IufFile to be deleted

iufFileGetHistoryTree()

iuhn_t iufFileGetHistoryTree

(

iuf_t

file

)

Gets the history node of the IufFile.

Returns

Returns the IufHistoryNode when successful or NULL in case of an error

Parameters

file	The IufFile of interest

iufFileGetType()

const char* iufFileGetType

(

iuf_t

file

)

Gets the type label of the IufFile.

Returns

Returns the type label

Parameters

file	The IufFile of interest

iufFileLoad()

iuf_t iufFileLoad

(

char *

pFilename

)

Create an IufFile from the file pFilename.

Returns

Return the IufFile or IUFI_INVALID if the file could not be loaded.

Parameters

pFilename

The filename of the IufFile

iufFileSetHistoryTree()

int iufFileSetHistoryTree	(	iuf_t	file,
		iuhn_t	history
	)

Sets the IufHistoryNode of the IufFile.

Returns

Returns IUF_E_OK when successful and IUF_ERR_VALUE otherwise.

Parameters

file	the IufFile of interest
history	the IufHistoryNode that is set