ファイルハンドルを伴わないファイルIOに関するWindowsAPIを集約したクラス [詳解]

#include <FileUtility.h>

alt::FileUtility の継承関係図

公開メンバ関数
APIENTRY	FileUtility ()
	コンストラクタ

APIENTRY	~FileUtility ()
	デストラクタ

基底クラス alt::WindowsLibrary に属する継承公開メンバ関数
APIENTRY	WindowsLibrary ()
	コンストラクタ

virtual APIENTRY	~WindowsLibrary ()
	デストラクタ

virtual DWORD APIENTRY	GetErrNo () const
	WindowsAPIのエラー値を取得します。

virtual VOID APIENTRY	SetErrNo ()
	WINAPIエラーの情報を設定します。

静的公開メンバ関数
static BOOL APIENTRY	Copy (LPCTSTR source, LPCTSTR dest, BOOL bFailIfExists=FALSE)
	ファイルのコピー

static BOOL APIENTRY	Delete (LPCTSTR name)
	ファイルの削除

static skeleton::Array< FileInfo2 > APIENTRY	DirectoryWatch (LPCTSTR lpctszWatchDirectory, DWORD dwTimeout)
	ディレクトリの監視

static skeleton::Array< FileInfo1 > APIENTRY	Find (LPCTSTR target, LPCTSTR name, BOOL bRecurse=FALSE)
	ファイルの検索

static VOID APIENTRY	Find2 (LPCTSTR target, LPCTSTR name, BOOL bRecurse, skeleton::Array< FileInfo1 > &response)

static TString APIENTRY	GetAbsolutePath (LPCTSTR lpctszRelativePath)
	カレントディレクトリのパスを連結して絶対パスの作成

static TString APIENTRY	GetCurrentDir ()
	カレントディレクトリ名の取得

static TString APIENTRY	GetTemporaryFileName (LPCTSTR lpctszPath, LPCTSTR lpctszPrefix, UINT nNumber)
	テンポラリファイル名を取得します。

static TString APIENTRY	GetTemporaryPath ()
	テンポラリフォルダを取得します。

static BOOL APIENTRY	IsDirectory (LPCTSTR name)
	ディレクトリの存在確認

static BOOL APIENTRY	IsExist (LPCTSTR name)
	ディレクトリ・ファイルの存在確認

static BOOL APIENTRY	MakeDir (LPCTSTR name)
	ディレクトリの作成

static BOOL APIENTRY	MakeHardLink (LPCTSTR source, LPCTSTR link)
	ハードリンクの作成

static BOOL APIENTRY	Move (LPCTSTR source, LPCTSTR dest)
	ファイルの移動

static BOOL APIENTRY	RemoveDir (LPCTSTR name)
	ディレクトリの削除

static BOOL APIENTRY	SetCurrentDir (LPCTSTR name)
	カレントディレクトリの移動

static INT APIENTRY	SHFileOperations (ShellOperation operation, LPCTSTR lpctszFrom, LPCTSTR lpctszTo)

その他の継承メンバ
基底クラス alt::WindowsLibrary に属する継承限定公開変数類
DWORD	_dwErrorNo

詳解

ファイルハンドルを伴わないファイルIOに関するWindowsAPIを集約したクラス

FileUtility.h の 228 行目に定義があります。

構築子と解体子

◆ FileUtility()

APIENTRY alt::FileUtility::FileUtility ( )

inline

コンストラクタ

FileUtility.h の 232 行目に定義があります。

◆ ~FileUtility()

APIENTRY alt::FileUtility::~FileUtility ( )

inline

デストラクタ

FileUtility.h の 235 行目に定義があります。

関数詳解

◆ Copy()

BOOL FileUtility::Copy	(	LPCTSTR	source,
		LPCTSTR	dest,
		BOOL	bFailIfExists = `FALSE`
	)

static

ファイルのコピー

引数

source	コピー元ファイル名
dest	コピー先ファイル名
bFailIfExists	ファイルが存在する場合に実行するか否か

戻り値: BOOL

戻り値

TRUE(成功)
FALSE(失敗)

FileUtility.cpp の 62 行目に定義があります。

参照元 WindowsLibraryTest::TEST_CLASS().

◆ Delete()

BOOL FileUtility::Delete ( LPCTSTR name )

static

ファイルの削除

引数

name 削除するファイル名

戻り値: BOOL

戻り値

TRUE(成功)
FALSE(失敗)

FileUtility.cpp の 57 行目に定義があります。

参照元 alt::Log::RotateLogFile(), WindowsLibraryTest::TEST_CLASS().

◆ DirectoryWatch()

skeleton::Array< FileInfo2 > FileUtility::DirectoryWatch	(	LPCTSTR	lpctszWatchDirectory,
		DWORD	dwTimeout
	)

static

ディレクトリの監視

引数

lpctszWatchDirectory	監視対象ディレクトリ名
dwTimeout	監視時間

戻り値: alt::skeleton::Array<alt::TString>

戻り値

監視中に変化があったファイル情報

FileUtility.cpp の 271 行目に定義があります。

参照先 alt::FileInfo1::_AccessTime, alt::FileInfo1::_Attribute, alt::FileInfo2::_ChangeTime, alt::FileInfo1::_CreateTime, alt::FileInfo2::_dwAction, alt::FileInfo2::_FileID, alt::FileInfo::_FileName, alt::FileInfo::_FileSize, alt::FileInfo1::_UpdateTime, alt::skeleton::Array< T >::Add(), alt::Event::Create(), alt::HandleLibrary::GetHandle(), alt::TString::Ptr(), alt::WaitableHandleLibrary::Wait().

参照元 WindowsLibraryTest::TEST_CLASS().

◆ Find()

skeleton::Array< FileInfo1 > FileUtility::Find	(	LPCTSTR	target,
		LPCTSTR	name,
		BOOL	bRecurse = `FALSE`
	)

static

ファイルの検索

引数

target	検索対象ディレクトリ名
name	検索対象ファイル名
bRecurse	再帰するか否か

戻り値: 検索結果

FileUtility.cpp の 134 行目に定義があります。

参照先 alt::FileInfo1::_AccessTime, alt::FileInfo1::_Attribute, alt::FileInfo1::_CreateTime, alt::FileInfo::_FileName, alt::FileInfo::_FileSize, alt::FileInfo::_FolderName, alt::FileInfo1::_UpdateTime, alt::skeleton::Array< T >::Add(), alt::TString::Ctr(), Find(), alt::TString::Format().

参照元 Find(), alt::Log::FindHistory(), WindowsLibraryTest::TEST_CLASS().

◆ Find2()

VOID FileUtility::Find2	(	LPCTSTR	target,
		LPCTSTR	name,
		BOOL	bRecurse,
		skeleton::Array< FileInfo1 > &	response
	)

static

FileUtility.cpp の 205 行目に定義があります。

参照先 alt::FileInfo1::_AccessTime, alt::FileInfo1::_Attribute, alt::FileInfo1::_CreateTime, alt::FileInfo::_FileName, alt::FileInfo::_FileSize, alt::FileInfo::_FolderName, alt::FileInfo1::_UpdateTime, alt::skeleton::Array< T >::Add(), alt::TString::Ctr(), Find2(), alt::TString::Format().

参照元 Find2(), WindowsLibraryTest::TEST_CLASS().

◆ GetAbsolutePath()

TString FileUtility::GetAbsolutePath ( LPCTSTR lpctszRelativePath )

static

カレントディレクトリのパスを連結して絶対パスの作成

引数

lpctszRelativePath カレントディレクトリからの相対パス

戻り値: TString カレントディレクトリ＋指定パス

FileUtility.cpp の 115 行目に定義があります。

参照先 alt::TString::Ptr().

参照元 WindowsLibraryTest::TEST_CLASS().

◆ GetCurrentDir()

alt::TString FileUtility::GetCurrentDir ( )

static

カレントディレクトリ名の取得

戻り値: カレントディレクトリ名

FileUtility.cpp の 97 行目に定義があります。

参照先 alt::TString::Ptr().

参照元 WindowsLibraryTest::TEST_CLASS().

◆ GetTemporaryFileName()

TString FileUtility::GetTemporaryFileName	(	LPCTSTR	lpctszPath,
		LPCTSTR	lpctszPrefix,
		UINT	nNumber
	)

static

テンポラリファイル名を取得します。

引数

[in]	lpctszPath	ファイルパス
[in]	lpctszPrefix	ファイル名プレフィックス(３文字まで)
[in]	nNumber	ファイル名に使用される番号(下位１６ビットまで)

覚え書き: nNumberに０を指定するとシステムが生成します。

FileUtility.cpp の 72 行目に定義があります。

参照先 alt::TString::Ptr().

参照元 WindowsLibraryTest::TEST_CLASS().

◆ GetTemporaryPath()

TString FileUtility::GetTemporaryPath ( )

static

テンポラリフォルダを取得します。

戻り値: TString フォルダ名

FileUtility.cpp の 106 行目に定義があります。

参照先 alt::TString::Ptr().

参照元 WindowsLibraryTest::TEST_CLASS().

◆ IsDirectory()

BOOL FileUtility::IsDirectory ( LPCTSTR name )

static

ディレクトリの存在確認

引数

name	確認するディレクトリ名

戻り値: BOOL

戻り値

TRUE(成功)
FALSE(失敗)

FileUtility.cpp の 124 行目に定義があります。

参照元 WindowsLibraryTest::TEST_CLASS().

◆ IsExist()

BOOL FileUtility::IsExist ( LPCTSTR name )

static

ディレクトリ・ファイルの存在確認

引数

name	ディレクトリ・ファイル名

戻り値: BOOL

戻り値

TRUE(存在する)
FALSE(存在しない)

FileUtility.cpp の 129 行目に定義があります。

参照元 _tmain(), alt::Log::AppendLog(), alt::MiddleLibrary::SetProfile(), WindowsLibraryTest::TEST_CLASS().

◆ MakeDir()

BOOL FileUtility::MakeDir ( LPCTSTR name )

static

ディレクトリの作成

引数

name ディレクトリ名

戻り値: BOOL

戻り値

TRUE(成功)
FALSE(失敗)

FileUtility.cpp の 82 行目に定義があります。

参照元 WindowsLibraryTest::TEST_CLASS().

◆ MakeHardLink()

BOOL FileUtility::MakeHardLink	(	LPCTSTR	source,
		LPCTSTR	link
	)

static

ハードリンクの作成

引数

source	作成元ファイル名
link	作成リンク名

覚え書き: HardLinkはdirコマンドで区別がつかない。アイコンにも変化が現れない。こちらは管理者権限が不要である。コマンドは、mklink /h 〜で作成する。削除はdel。ディレクトリに対しては作成不可。同一ボリュームのみ。

FileUtility.cpp の 418 行目に定義があります。

参照元 WindowsLibraryTest::TEST_CLASS().

◆ Move()

BOOL FileUtility::Move	(	LPCTSTR	source,
		LPCTSTR	dest
	)

static

ファイルの移動

引数

source	移動元ファイル名
dest	移動先ファイル名

戻り値: BOOL

戻り値

TRUE(成功)
FALSE(失敗)

FileUtility.cpp の 67 行目に定義があります。

参照元 alt::Log::RotateLogFile(), WindowsLibraryTest::TEST_CLASS().

◆ RemoveDir()

BOOL FileUtility::RemoveDir ( LPCTSTR name )

static

ディレクトリの削除

引数

name ディレクトリ名

戻り値: BOOL

戻り値

TRUE(成功)
FALSE(失敗)

覚え書き: ディレクトリ内のファイルを再帰的に削除するには、 SHFileOperation()を使用します。

FileUtility.cpp の 87 行目に定義があります。

参照元 WindowsLibraryTest::TEST_CLASS().

◆ SetCurrentDir()

BOOL FileUtility::SetCurrentDir ( LPCTSTR name )

static

カレントディレクトリの移動

引数

name ディレクトリ名

戻り値: BOOL

戻り値

TRUE(成功)
FALSE(失敗)

FileUtility.cpp の 92 行目に定義があります。

参照元 WindowsLibraryTest::TEST_CLASS().

◆ SHFileOperations()

INT FileUtility::SHFileOperations	(	ShellOperation	operation,
		LPCTSTR	lpctszFrom,
		LPCTSTR	lpctszTo
	)

static

FileUtility.cpp の 423 行目に定義があります。

参照元 WindowsLibraryTest::TEST_CLASS().

このクラス詳解は次のファイルから抽出されました:

C:/Users/masah/source/repos/KumaKuma0421/Alternate/WindowsLibrary/FileUtility.h
C:/Users/masah/source/repos/KumaKuma0421/Alternate/WindowsLibrary/FileUtility.cpp

公開メンバ関数

静的公開メンバ関数

その他の継承メンバ

詳解

構築子と解体子

◆ FileUtility()

◆ ~FileUtility()

関数詳解

◆ Copy()

◆ Delete()

◆ DirectoryWatch()

◆ Find()

◆ Find2()

◆ GetAbsolutePath()

◆ GetCurrentDir()

◆ GetTemporaryFileName()

◆ GetTemporaryPath()

◆ IsDirectory()

◆ IsExist()

◆ MakeDir()

◆ MakeHardLink()

◆ Move()

◆ RemoveDir()

◆ SetCurrentDir()

◆ SHFileOperations()