Files.c File Reference

A few commonly used functions for reading and writing files. More...

#include "ApgUtilities.h"

Go to the source code of this file.

Functions
apg_uint	uiGetFileSize (const char *cpFileName)
apg_uint	uiGetFile (const char *cpFileName, void *vpBuffer)
apg_uint	uiWriteFile (const char *cpFileName, void *vpData, apg_uint uiDataLen)

Detailed Description

A few commonly used functions for reading and writing files.

Definition in file Files.c.

Function Documentation

uiGetFile()

apg_uint uiGetFile	(	const char *	cpFileName,
		void *	vpBuffer
	)

Read an entire file into memory.

Parameters

cpFileName	the name of the file to get
vpBuffer	pointer to the memory area to read the file into.

See also

uiGetFileSize()

Returns

the file size on success, 0 if the file does not exist

Definition at line 71 of file Files.c.

uiGetFileSize()

apg_uint uiGetFileSize

(

const char *

cpFileName

)

Get the size of a file in bytes.

Useful when dynamically allocating a buffer for reading the entire file.

Parameters

cpFileName

the name of the file whose size to get

See also

uiGetFile()

Returns

the file size on success, 0 if the file does not exist

Definition at line 40 of file Files.c.

uiWriteFile()

apg_uint uiWriteFile	(	const char *	cpFileName,
		void *	vpData,
		apg_uint	uiDataLen
	)

Write data into a file. If the file already exists its data is overwritten.

Parameters

cpFileName	the name of the file to write
vpData	pointer to the memory area to write.
uiDataLen	the number of bytes of data to write

Returns

the number of bytes written. If not equal to uiDataLen an error occurred.

Definition at line 108 of file Files.c.