---

_CxFile Struct Reference

A representation of a file on the filesystem or in an archive. More...

#include <file.h>

Data Fields
CxArchive *	archive
	The archive that owns this file, if any.
CxDirectory *	parentDir
	The parent directory.
char *	name
	The base filename.
CxFileType	type
	The type of file.
char *	path
	The full path to the file.
char *	physPath
	The full physical path to the file.
mode_t	mode
	The file's mode.
uid_t	uid
	The file's owner user ID.
gid_t	gid
	The file's owner group ID.
unsigned int	compressedSize
	The compressed file size.
unsigned int	uncompressedSize
	The uncompressed file size.
time_t	date
	The time in seconds since the epoch.
char	isLocalFile
	Non-zero if the file is stored locally.
void *	moduleData
	Module-specific data.
unsigned int	refCount
	The reference count.
CxFile *	prev
	The previous file in the list.
CxFile *	next
	The next file in the list.

---

Detailed Description

A representation of a file on the filesystem or in an archive.

---

Field Documentation

CxArchive* _CxFile::archive

The archive that owns this file, if any.

unsigned int _CxFile::compressedSize

The compressed file size.

time_t _CxFile::date

The time in seconds since the epoch.

gid_t _CxFile::gid

The file's owner group ID.

char _CxFile::isLocalFile

Non-zero if the file is stored locally.

mode_t _CxFile::mode

The file's mode.

void* _CxFile::moduleData

Module-specific data.

char* _CxFile::name

The base filename.

CxFile* _CxFile::next

The next file in the list.

CxDirectory* _CxFile::parentDir

The parent directory.

char* _CxFile::path

The full path to the file. This may include a non-physical path (FTP site, archive, etc.) in the path.

char* _CxFile::physPath

The full physical path to the file. If the file is non-local, this will be a temporary filename.

CxFile* _CxFile::prev

The previous file in the list.

unsigned int _CxFile::refCount

The reference count.

CxFileType _CxFile::type

The type of file.

uid_t _CxFile::uid

The file's owner user ID.

unsigned int _CxFile::uncompressedSize

The uncompressed file size.

---

The documentation for this struct was generated from the following file:

• file.h

---