TekStatFile Class Reference

Inheritance diagram for TekStatFile:

Inheritance graph
[legend]
Collaboration diagram for TekStatFile:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TekStatFile ()
 ~TekStatFile ()
virtual TEKERR put_Filename (const uchar_t *Filename)=0
virtual TEKERR put_FILE (FILE *FileDescriptor)=0
virtual TEKERR put_UserInfoToAccess (uuid_t *UUIDOfUserInfo)=0
virtual TEKERR MakeTekFile (TekFileType TekType, TekFile **RetVal)=0
virtual TEKERR get_Dev (dev_t *Dev)=0
virtual TEKERR get_DevNo (dev_t *DevNo)=0
virtual TEKERR get_FileSerialNo (ino_t *SerialNo)=0
virtual TEKERR get_Mode (mode_t *FileMode)=0
virtual TEKERR get_ModeString (uchar_t **FileModeString)=0
virtual TEKERR put_Mode (mode_t NewFileMode)=0
virtual TEKERR put_ModeString (const uchar_t *NewFileModeString)=0
virtual TEKERR get_LinkCount (nlink_t *LinkCount)=0
virtual TEKERR get_UID (uid_t *UID)=0
virtual TEKERR put_UID (uid_t UID)=0
virtual TEKERR get_GID (gid_t *GID)=0
virtual TEKERR put_GID (gid_t GID)=0
virtual TEKERR get_UIDString (uchar_t **UIDString)=0
virtual TEKERR put_UIDString (const uchar_t *UIDString)=0
virtual TEKERR get_GIDString (uchar_t **GIDString)=0
virtual TEKERR put_GIDString (const uchar_t *GIDString)=0
virtual TEKERR get_Size (unsigned long *FileSize)=0
virtual TEKERR get_Size64 (uint64_t *FileSize)=0
virtual TEKERR get_BlockSize (blksize_t *FileBlockSize)=0
virtual TEKERR get_BlockCount (blkcnt64_t *FileBlockCount)=0
virtual TEKERR get_TimeOfLastAccessRaw (unsigned long **RetVal)=0
virtual TEKERR get_TimeOfLastModificationRaw (unsigned long **RetVal)=0
virtual TEKERR get_TimeOfLastStatChangeRaw (unsigned long **RetVal)=0
virtual TEKERR get_TimeOfLastAccess (uchar_t **RetVal)=0
virtual TEKERR get_TimeOfLastModification (uchar_t **RetVal)=0
virtual TEKERR get_TimeOfLastStatChange (uchar_t **RetVal)=0

Detailed Description

This interface defines the standard for viewing file information as a file stands on a device.

This interface is INHERITABLE.

NOTE: Most interfaces implementing TekStatFile might give out a TEKERR_ACCESS if you do not put_Filename() or put_FILE().

Author:
Kevin McBride

Definition at line 50 of file TekStatFile.cpp.


Constructor & Destructor Documentation

TekStatFile  ) 
 

Instantizer.

Definition at line 100 of file TekStatFile.cpp.

~TekStatFile  ) 
 

Destructor.

Definition at line 111 of file TekStatFile.cpp.


Member Function Documentation

TEKERR get_BlockCount blkcnt64_t *  FileBlockCount  )  [pure virtual]
 

Retrieves the amount of blocks the file is taking.

Definition at line 361 of file TekStatFile.cpp.

TEKERR get_BlockSize blksize_t *  FileBlockSize  )  [pure virtual]
 

Retrieves the block size to use for optimum performance.

Definition at line 351 of file TekStatFile.cpp.

TEKERR get_Dev dev_t *  Dev  )  [pure virtual]
 

Retrieves the device.

Definition at line 170 of file TekStatFile.cpp.

TEKERR get_DevNo dev_t *  DevNo  )  [pure virtual]
 

Retrieves the device number.

Definition at line 180 of file TekStatFile.cpp.

TEKERR get_FileSerialNo ino_t *  SerialNo  )  [pure virtual]
 

Retrieves the file serial number.

Definition at line 190 of file TekStatFile.cpp.

TEKERR get_GID gid_t *  GID  )  [pure virtual]
 

Retrieves the group ID in raw form.

Definition at line 271 of file TekStatFile.cpp.

TEKERR get_GIDString uchar_t **  GIDString  )  [pure virtual]
 

Retrieves the Groupname behind the GID.

Definition at line 311 of file TekStatFile.cpp.

TEKERR get_LinkCount nlink_t *  LinkCount  )  [pure virtual]
 

Retrieves the mode string.

Definition at line 241 of file TekStatFile.cpp.

TEKERR get_Mode mode_t *  FileMode  )  [pure virtual]
 

Retrieves the raw mode.

Definition at line 200 of file TekStatFile.cpp.

TEKERR get_ModeString uchar_t **  FileModeString  )  [pure virtual]
 

Retrieves the mode string.

Definition at line 210 of file TekStatFile.cpp.

TEKERR get_Size unsigned long *  FileSize  )  [pure virtual]
 

Retrieves the file size.

Definition at line 331 of file TekStatFile.cpp.

TEKERR get_Size64 uint64_t *  FileSize  )  [pure virtual]
 

Retrieves the file size, cast to a uint64_t.

Definition at line 341 of file TekStatFile.cpp.

TEKERR get_TimeOfLastAccess uchar_t **  RetVal  )  [pure virtual]
 

Retrieves the time of last access to file.

Definition at line 401 of file TekStatFile.cpp.

TEKERR get_TimeOfLastAccessRaw unsigned long **  RetVal  )  [pure virtual]
 

Retrieves the time of last access to file, in raw form.

Definition at line 371 of file TekStatFile.cpp.

TEKERR get_TimeOfLastModification uchar_t **  RetVal  )  [pure virtual]
 

Retrieves the time of last modification to file.

Definition at line 411 of file TekStatFile.cpp.

TEKERR get_TimeOfLastModificationRaw unsigned long **  RetVal  )  [pure virtual]
 

Retrieves the time of last modification to file, in raw form.

Definition at line 381 of file TekStatFile.cpp.

TEKERR get_TimeOfLastStatChange uchar_t **  RetVal  )  [pure virtual]
 

Retrieves the time of last stat change to file.

Definition at line 421 of file TekStatFile.cpp.

TEKERR get_TimeOfLastStatChangeRaw unsigned long **  RetVal  )  [pure virtual]
 

Retrieves the time of last stat change to file, in raw form.

Definition at line 391 of file TekStatFile.cpp.

TEKERR get_UID uid_t *  UID  )  [pure virtual]
 

Retrieves the user ID in raw form.

Definition at line 251 of file TekStatFile.cpp.

TEKERR get_UIDString uchar_t **  UIDString  )  [pure virtual]
 

Retrieves the Username behind the UID.

Definition at line 291 of file TekStatFile.cpp.

MakeTekFile TekFileType  TekType,
TekFile **  RetVal
[pure virtual]
 

Makes an unopened instance of a TekFile, type TekType. This function is included here as a timesaver inside consitional blocks.

TEKERR put_FILE FILE *  FileDescriptor  )  [pure virtual]
 

Retrieves information from file descriptor.

Definition at line 133 of file TekStatFile.cpp.

TEKERR put_Filename const uchar_t Filename  )  [pure virtual]
 

Retrieves information from named file.

Definition at line 123 of file TekStatFile.cpp.

TEKERR put_GID gid_t  GID  )  [pure virtual]
 

Sets the group ID in raw form.

Definition at line 281 of file TekStatFile.cpp.

TEKERR put_GIDString const uchar_t GIDString  )  [pure virtual]
 

Sets the Groupname.

Definition at line 321 of file TekStatFile.cpp.

TEKERR put_Mode mode_t  NewFileMode  )  [pure virtual]
 

Sets the mode in raw form.

Definition at line 220 of file TekStatFile.cpp.

TEKERR put_ModeString const uchar_t NewFileModeString  )  [pure virtual]
 

Sets the mode using string format. The format to follow will be documented by the inheriting interfaces.

Definition at line 231 of file TekStatFile.cpp.

TEKERR put_UID uid_t  UID  )  [pure virtual]
 

Sets the user ID in raw form.

Definition at line 261 of file TekStatFile.cpp.

TEKERR put_UIDString const uchar_t UIDString  )  [pure virtual]
 

Sets the Username.

Definition at line 301 of file TekStatFile.cpp.

TEKERR put_UserInfoToAccess uuid_t *  UUIDOfUserInfo  )  [pure virtual]
 

Sets the userinfo access interface to read usernames from.

NOTE: If this is not called, the inheriting interface will choose the scheme on its own, which could vary from operating system to operating system. So, unless you don't mind of the inheriting interface choosing the scheme for you, you should utilize setting this parameter.

Definition at line 149 of file TekStatFile.cpp.


The documentation for this class was generated from the following file: SourceForge.net Logo  Technical Library Template Interface Project Page