Simple Platform Independent File Management Functions. More...

#include <File.h>

Public Member Functions
	HK_File ()
	Constructor. More...

	HK_File (string Path)
	Overloaded Constructor, Sets Path. More...

bool	CopyFile (string Original, string Target)
	A Simple C Function To Copy File From Original To Target. More...

bool	Copy (string Target)
	Copy HK_FilePath To Target. More...

string	GetPath ()
	Returns Path. More...

string	ReadText ()
	Reads HK_FilePath Into String. More...

string	ReadTextFile (string FileName)
	Reads FileName Into String. More...

vector< string >	ScanFiles (string Path)
	Not Setup Yet. More...

void	SetPath (string Path)

bool	WriteText (string Text)
	Writes Text To HK_FilePath. More...

bool	WriteTextFile (string FileName, string Text)
	Opens Filename And Writes Text. More...

Private Attributes
string	HK_FilePath

Detailed Description

Simple Platform Independent File Management Functions.

Since: 02/04/2020

Definition at line 26 of file File.h.

Constructor & Destructor Documentation

◆ HK_File() [1/2]

HK_File::HK_File ( )

Constructor.

Definition at line 12 of file HK_File.cpp.

◆ HK_File() [2/2]

HK_File::HK_File ( string Path )

Overloaded Constructor, Sets Path.

Definition at line 14 of file HK_File.cpp.

Member Function Documentation

◆ Copy()

bool HK_File::Copy ( string Target )

Copy HK_FilePath To Target.

Definition at line 17 of file HK_File.cpp.

◆ CopyFile()

bool HK_File::CopyFile	(	string	Original,
		string	Target
	)

A Simple C Function To Copy File From Original To Target.

Returns: True On Success.

Definition at line 23 of file HK_File.cpp.

◆ GetPath()

string HK_File::GetPath ( )

Returns Path.

Definition at line 52 of file HK_File.cpp.

◆ ReadText()

string HK_File::ReadText ( )

Reads HK_FilePath Into String.

Returns: Error String If File Not Found

Definition at line 55 of file HK_File.cpp.

◆ ReadTextFile()

string HK_File::ReadTextFile ( string FileName )

Reads FileName Into String.

Returns: Error String If File Not Found

Definition at line 61 of file HK_File.cpp.

◆ ScanFiles()

vector< string > HK_File::ScanFiles ( string Path )

Not Setup Yet.

Definition at line 106 of file HK_File.cpp.

◆ SetPath()

void HK_File::SetPath ( string Path )

◆ WriteText()

bool HK_File::WriteText ( string Text )

Writes Text To HK_FilePath.

Returns: True On Success

Definition at line 80 of file HK_File.cpp.

◆ WriteTextFile()

bool HK_File::WriteTextFile	(	string	FileName,
		string	Text
	)

Opens Filename And Writes Text.

Returns: True On Success

Definition at line 86 of file HK_File.cpp.

Member Data Documentation

◆ HK_FilePath

string HK_File::HK_FilePath

private

Definition at line 28 of file File.h.

The documentation for this class was generated from the following files:

/home/millj/Documents/1-Code/HatchKeeper/headers/File.h
/home/millj/Documents/1-Code/HatchKeeper/src/HK_File.cpp

Public Member Functions

Private Attributes