file.h File Reference

#include "wizard/exception.h"

Include dependency graph for file.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef struct _FileInfo	FileInfo

Enumerations
enum	FileMode { ReadFileMode , WriteFileMode }

Functions
WizardExport const char *	GetFilePath (const FileInfo *)
WizardExport const struct stat *	GetFileProperties (const FileInfo *)
WizardExport FileInfo *	AcquireFileInfo (const char *, const char *, const FileMode mode, ExceptionInfo *)
WizardExport FileInfo *	DestroyFileInfo (FileInfo *, ExceptionInfo *)
WizardExport int	GetFileDescriptor (const FileInfo *)
WizardExport int	ReadFileByte (FileInfo *)
WizardExport WizardBooleanType	DestroyFile (FileInfo *, ExceptionInfo *)
WizardExport WizardBooleanType	ReadFile16Bits (FileInfo *, unsigned short *)
WizardExport WizardBooleanType	ReadFile32Bits (FileInfo *, size_t *)
WizardExport WizardBooleanType	ReadFile64Bits (FileInfo *, WizardSizeType *)
WizardExport WizardBooleanType	ReadFileChunk (FileInfo *, void *, const size_t)
WizardExport WizardBooleanType	WriteFileChunk (FileInfo *, const void *, const size_t)
WizardExport WizardBooleanType	WriteFile16Bits (FileInfo *, const unsigned short)
WizardExport WizardBooleanType	WriteFile32Bits (FileInfo *, const size_t)
WizardExport WizardBooleanType	WriteFile64Bits (FileInfo *, const WizardSizeType)

Typedef Documentation

FileInfo

typedef struct _FileInfo FileInfo

Definition at line 34 of file file.h.

Enumeration Type Documentation

FileMode

enum FileMode

Enumerator
ReadFileMode
WriteFileMode

Definition at line 27 of file file.h.

Function Documentation

AcquireFileInfo()

WizardExport FileInfo * AcquireFileInfo	(	const char *	,
		const char *	,
		const FileMode	mode,
		ExceptionInfo *
	)

DestroyFile()

WizardExport WizardBooleanType DestroyFile	(	FileInfo *	,
		ExceptionInfo *
	)

DestroyFileInfo()

WizardExport FileInfo * DestroyFileInfo	(	FileInfo *	file_info,
		ExceptionInfo *	exception
	)

Definition at line 431 of file file.c.

References DestroyString(), _FileInfo::file, FileError, GetWizardModule, LockSemaphoreInfo(), LogWizardEvent(), _FileInfo::path, RelinquishFileLock(), RelinquishSemaphoreInfo(), RelinquishWizardMemory(), _FileInfo::semaphore, _FileInfo::signature, ThrowWizardException(), TraceEvent, UnlockSemaphoreInfo(), and WizardSignature.

Referenced by AcquireFileInfo(), ExportKeyringKey(), GetEntropyFromReservoir(), ImportKeyringKey(), PrintKeyringProperties(), and SaveEntropyToReservoir().

GetFileDescriptor()

WizardExport int GetFileDescriptor

(

const FileInfo *

)

GetFilePath()

WizardExport const char * GetFilePath

(

const FileInfo *

file_info

)

Definition at line 505 of file file.c.

References GetWizardModule, LogWizardEvent(), _FileInfo::path, _FileInfo::signature, TraceEvent, and WizardSignature.

Referenced by ExportKeyringKey(), GetEntropyFromReservoir(), ImportKeyringKey(), PrintKeyringProperties(), and SaveEntropyToReservoir().

GetFileProperties()

WizardExport const struct stat * GetFileProperties

(

const FileInfo *

file_info

)

Definition at line 535 of file file.c.

References GetWizardModule, LogWizardEvent(), _FileInfo::properties, _FileInfo::signature, TraceEvent, and WizardSignature.

Referenced by PrintKeyringProperties().

ReadFile16Bits()

WizardExport WizardBooleanType ReadFile16Bits	(	FileInfo *	,
		unsigned short *
	)

ReadFile32Bits()

WizardExport WizardBooleanType ReadFile32Bits	(	FileInfo *	,
		size_t *
	)

ReadFile64Bits()

WizardExport WizardBooleanType ReadFile64Bits	(	FileInfo *	,
		WizardSizeType *
	)

ReadFileByte()

WizardExport int ReadFileByte

(

FileInfo *

file_info

)

Definition at line 566 of file file.c.

References ReadFileChunk(), _FileInfo::signature, WizardFalse, and WizardSignature.

ReadFileChunk()

WizardExport WizardBooleanType ReadFileChunk	(	FileInfo *	,
		void *	,
		const size_t
	)

WriteFile16Bits()

WizardExport WizardBooleanType WriteFile16Bits	(	FileInfo *	,
		const unsigned short
	)

WriteFile32Bits()

WizardExport WizardBooleanType WriteFile32Bits	(	FileInfo *	,
		const size_t
	)

WriteFile64Bits()

WizardExport WizardBooleanType WriteFile64Bits	(	FileInfo *	file_info,
		const WizardSizeType	value
	)

Definition at line 984 of file file.c.

References GetWizardModule, LogWizardEvent(), TraceEvent, and WriteFileChunk().

Referenced by ImportKeyringKey(), and SaveEntropyToReservoir().

WriteFileChunk()

WizardExport WizardBooleanType WriteFileChunk	(	FileInfo *	,
		const void *	,
		const size_t
	)