hdicoreFiles.h File Reference

Header file for file and folder manipulation from a plugin. More...

#include <vector>
#include "hdicoreTypes.h"

Include dependency graph for hdicoreFiles.h:

Namespaces
namespace	hdi::core::files
	Organizes all file-/folder-related functionality into one namespace for convenience.

Typedefs
typedef std::vector< std::string >	hdi::core::files::StringVector

Functions
bool	hdi::core::files::exists (const std::string &filePath_)
	Checks for the existence of a file or folder.
bool	hdi::core::files::onNetwork (const std::string &filePath_)
	Gets whether the given file is stored on a network drive.
bool	hdi::core::files::copy (const std::string &filePath_, const std::string &destPath_)
	Copies a source file to a destination path.
bool	hdi::core::files::rename (const std::string &filePath_, const std::string &newName_)
	Renames a file.
bool	hdi::core::files::move (const std::string &fromFilePath_, const std::string &toFolderPath_)
	Moves a file from one location to another.
int64_t	hdi::core::files::getSize (const std::string &filePath_)
	Returns the size of a file in bytes.
std::string	hdi::core::files::getTextContents (const std::string &filePath_)
	Gets the contents of a text-based file, assumed to be in UTF-8 encoding.
bool	hdi::core::files::setTextContents (const std::string &filePath_, const std::string &contents_)
	Sets the contents of a text-based file in UTF-8 encoding.
bool	hdi::core::files::getPermissions (const std::string &filePath_, mode_t &perms__)
	Gets the permission bits of a file or folder.
bool	hdi::core::files::makeDirectory (const std::string &path_, const mode_t perms_)
	Cross-platform function to create a directory at a given path with given permissions.
bool	hdi::core::files::filesInDirectory (const std::string &path_, StringVector &files__)
	Cross-platform function to retrieve the names of every file in a given directory.
bool	hdi::core::files::moveToTrash (const std::string &filePath_)
	Moves a file to the Trash (Mac) or Recycle Bin (Windows)
bool	hdi::core::files::ungzip (const std::string &sourcePath_, const std::string &destPath_)
	Un-gzips a source file to a destination path.
std::string	hdi::core::files::platformPrefsPath (const std::string &subfolder_, const bool create_=true)
	Gets the prefs/registration/etc. folder path (given a subfolder inside it)

Detailed Description

Header file for file and folder manipulation from a plugin.

Copyright

Hot Door, Inc. 2010-2019