#include "xstypesconfig.h"
#include "pstdint.h"
#include <stdio.h>
#include "xsresultvalue.h"
#include "xsfilepos.h"
#include "xsstring.h"

Include dependency graph for xsfile.h:

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

Go to the source code of this file.

Classes
class	XsFile
	Encapsulates a file, providing a platform independent interface. More...

Macros
#define	XS_MAX_FILENAME_LENGTH PATH_MAX

#define	XSFILE_INITIALIZER { 0 }

Typedefs
typedef struct XsFile	XsFile

Macro Definition Documentation

◆ XS_MAX_FILENAME_LENGTH

#define XS_MAX_FILENAME_LENGTH PATH_MAX

Definition at line 78 of file xsfile.h.

◆ XSFILE_INITIALIZER

#define XSFILE_INITIALIZER { 0 }

Definition at line 86 of file xsfile.h.

Typedef Documentation

◆ XsFile

typedef struct XsFile XsFile

Definition at line 326 of file xsfile.h.

Function Documentation

◆ XsFile_close()

XSTYPES_DLL_API XsResultValue XsFile_close ( struct XsFile * thisPtr )

XSTYPES_DLL_API XsResultValue XsFile_create	(	struct XsFile *	thisPtr,
		const struct XsString *	filename,
		int	writeOnly
	)

XSTYPES_DLL_API XsResultValue XsFile_createText	(	struct XsFile *	thisPtr,
		const struct XsString *	filename,
		int	writeOnly
	)

XSTYPES_DLL_API void XsFile_destruct ( struct XsFile * thisPtr )

XSTYPES_DLL_API int XsFile_eof ( struct XsFile const * thisPtr )

XSTYPES_DLL_API XsResultValue XsFile_erase ( const struct XsString * filename )

XSTYPES_DLL_API XsResultValue XsFile_error ( struct XsFile const * thisPtr )

XSTYPES_DLL_API int XsFile_exists ( const struct XsString * filename )

XSTYPES_DLL_API XsResultValue XsFile_flush ( struct XsFile * thisPtr )

XSTYPES_DLL_API XsResultValue XsFile_fullPath	(	const struct XsString *	filename,
		struct XsString *	fullPath
	)

XSTYPES_DLL_API int XsFile_getc ( struct XsFile * thisPtr )

XSTYPES_DLL_API XsResultValue XsFile_getline	(	struct XsFile *	thisPtr,
		struct XsString *	line
	)

XSTYPES_DLL_API char* XsFile_gets	(	struct XsFile *	thisPtr,
		char *	str,
		int	num
	)

XSTYPES_DLL_API FILE* XsFile_handle ( struct XsFile * thisPtr )

XSTYPES_DLL_API int XsFile_isOpen ( const struct XsFile * thisPtr )

XSTYPES_DLL_API XsResultValue XsFile_open	(	struct XsFile *	thisPtr,
		const struct XsString *	filename,
		int	readOnly
	)

XSTYPES_DLL_API XsResultValue XsFile_openText	(	struct XsFile *	thisPtr,
		const struct XsString *	filename,
		int	readOnly
	)

XSTYPES_DLL_API XsResultValue XsFile_putc	(	struct XsFile *	thisPtr,
		int	character
	)

XSTYPES_DLL_API XsResultValue XsFile_puts	(	struct XsFile *	thisPtr,
		const char *	str
	)

XSTYPES_DLL_API XsFilePos XsFile_read	(	struct XsFile *	thisPtr,
		void *	destination,
		XsFilePos	size,
		XsFilePos	count
	)

XSTYPES_DLL_API XsResultValue XsFile_reopen	(	struct XsFile *	thisPtr,
		const struct XsString *	filename,
		const struct XsString *	mode
	)

XSTYPES_DLL_API XsResultValue XsFile_resize	(	struct XsFile *	thisPtr,
		XsFilePos	fileSize
	)

XSTYPES_DLL_API XsResultValue XsFile_seek	(	struct XsFile *	thisPtr,
		XsFilePos	offset
	)

XSTYPES_DLL_API XsResultValue XsFile_seek_r	(	struct XsFile *	thisPtr,
		XsFilePos	offset
	)

XSTYPES_DLL_API XsFilePos XsFile_tell ( struct XsFile const * thisPtr )

XSTYPES_DLL_API XsResultValue XsFile_truncate	(	struct XsFile *	thisPtr,
		XsFilePos	fileSize
	)

XSTYPES_DLL_API XsFilePos XsFile_write	(	struct XsFile *	thisPtr,
		const void *	source,
		XsFilePos	size,
		XsFilePos	count
	)

Classes

Macros

Typedefs

Macro Definition Documentation

◆ XS_MAX_FILENAME_LENGTH

◆ XSFILE_INITIALIZER

Typedef Documentation

◆ XsFile

Function Documentation

◆ XsFile_close()

◆ XsFile_create()

◆ XsFile_createText()

◆ XsFile_destruct()

◆ XsFile_eof()

◆ XsFile_erase()

◆ XsFile_error()

◆ XsFile_exists()

◆ XsFile_flush()

◆ XsFile_fullPath()

◆ XsFile_getc()

◆ XsFile_getline()

◆ XsFile_gets()

◆ XsFile_handle()

◆ XsFile_isOpen()

◆ XsFile_open()

◆ XsFile_openText()

◆ XsFile_putc()

◆ XsFile_puts()

◆ XsFile_read()

◆ XsFile_reopen()

◆ XsFile_resize()

◆ XsFile_seek()

◆ XsFile_seek_r()

◆ XsFile_tell()

◆ XsFile_truncate()

◆ XsFile_write()