CArchiver クラス

アーカイバクラス [詳解]

#include <TnbArchiver.h>

公開メンバ関数
int	Attract (const CStrVector &vs, LPCTSTR lpszOption=NULL)
	[操作] 格納. [詳解]
int	Attract (LPCTSTR lpszName, LPCTSTR lpszOption=NULL)
	[操作] 格納. [詳解]
int	AttractMem (LPCTSTR lpszName, time_t time, WORD wAttr, const CByteVector &vb, LPCTSTR lpszOption=NULL)
	[操作] メモリから格納 [詳解]
	CArchiver (CArchiverDllHandler *pDll)
	コンストラクタ [詳解]
int	Delete (const CStrVector &vs, LPCTSTR lpszOption=NULL)
	[操作] 削除. [詳解]
int	Delete (LPCTSTR lpszName, LPCTSTR lpszOption=NULL)
	[操作] 削除. [詳解]
int	Extract (const CStrVector &vs, LPCTSTR lpszOption=NULL)
	[操作] 展開. [詳解]
int	Extract (LPCTSTR lpszName, LPCTSTR lpszOption=NULL)
	[操作] 取得. [詳解]
int	ExtractMem (LPCTSTR lpszName, CByteVector &_vb, LPCTSTR lpszOption=NULL)
	[操作] 展開 [詳解]
int	ExtractWithDirectory (const CStrVector &vs, LPCTSTR lpszOption=NULL)
	[操作] 展開. [詳解]
int	ExtractWithDirectory (LPCTSTR lpszName, LPCTSTR lpszOption=NULL)
	[操作] 展開. [詳解]
CStr	GetTargetArchiveFile (void) const
	[取得] 対象アーカイブ取得 [詳解]
bool	SetTargetArchiveFile (LPCTSTR lpszArcFile)
	[設定] 対象アーカイブ指定 [詳解]
void	SetWorkDirectory (LPCTSTR lpszWorkDir)
	[設定] 作業ディレクトリ指定 [詳解]

詳解

アーカイバクラス

圧縮/展開をサポートするクラスです。

必要ファイル

TnbArchiver.h

日付

06/12/14 新規作成

09/07/16 作業ディレクトリを自動設定するようにした。

TnbArchiver.h の 34 行目に定義があります。

構築子と解体子

CArchiver()

CArchiver

(

CArchiverDllHandler *

pDll

)

コンストラクタ

引数

pDll	アーカイバDLL管理クラスのインスタンス。 本インスタンスで使用中、破棄してはいけません。

例外

CNullPointerException

使用できないアーカイバ管理クラスを指定すると、スローされます。

TnbArchiver.h の 44 行目に定義があります。

関数詳解

Attract() [1/2]

int Attract	(	const CStrVector &	vs,
		LPCTSTR	lpszOption = NULL
	)

[操作] 格納.

アーカイブファイルへファイルを格納します。

引数

vs	削除する名前。
lpszOption	追加オプション（省略可能）。

戻り値

0	成功
0以外	失敗。エラーコード。

TnbArchiver.h の 257 行目に定義があります。

Attract() [2/2]

int Attract	(	LPCTSTR	lpszName,
		LPCTSTR	lpszOption = NULL
	)

[操作] 格納.

アーカイブファイルへファイルを格納します。

引数

lpszName	格納する名前。ワイルドカードも可能。
lpszOption	追加オプション（省略可能）。

戻り値

0	成功
0以外	失敗。エラーコード。

TnbArchiver.h の 240 行目に定義があります。

AttractMem()

int AttractMem	(	LPCTSTR	lpszName,
		time_t	time,
		WORD	wAttr,
		const CByteVector &	vb,
		LPCTSTR	lpszOption = NULL
	)

[操作] メモリから格納

引数

[in]	lpszName	格納ファイル名。
[in]	time	格納時間。
[in]	wAttr	格納属性。
[in]	vb	格納内容。
[in]	lpszOption	追加オプション（省略可能）。

戻り値

0	正常終了
0以外	エラー発生

TnbArchiver.h の 276 行目に定義があります。

Delete() [1/2]

int Delete	(	const CStrVector &	vs,
		LPCTSTR	lpszOption = NULL
	)

[操作] 削除.

アーカイブファイルから削除します。

引数

vs	削除する名前。
lpszOption	追加オプション（省略可能）。

戻り値

0	成功
0以外	失敗。エラーコード。

TnbArchiver.h の 130 行目に定義があります。

Delete() [2/2]

int Delete	(	LPCTSTR	lpszName,
		LPCTSTR	lpszOption = NULL
	)

[操作] 削除.

アーカイブファイルから削除します。

引数

lpszName	削除する名前。ワイルドカードも可能。
lpszOption	追加オプション（省略可能）。

戻り値

0	成功
0以外	失敗。エラーコード。

TnbArchiver.h の 113 行目に定義があります。

Extract() [1/2]

int Extract	(	const CStrVector &	vs,
		LPCTSTR	lpszOption = NULL
	)

[操作] 展開.

アーカイブファイルからファイルを展開します。

引数

vs	削除する名前。
lpszOption	追加オプション（省略可能）。

戻り値

0	成功
0以外	失敗。エラーコード。

TnbArchiver.h の 164 行目に定義があります。

Extract() [2/2]

int Extract	(	LPCTSTR	lpszName,
		LPCTSTR	lpszOption = NULL
	)

[操作] 取得.

アーカイブファイルからファイルを展開します。

引数

lpszName	展開する名前。ワイルドカードも可能。
lpszOption	追加オプション（省略可能）。

戻り値

0	成功
0以外	失敗。エラーコード。

TnbArchiver.h の 147 行目に定義があります。

ExtractMem()

int ExtractMem	(	LPCTSTR	lpszName,
		CByteVector &	_vb,
		LPCTSTR	lpszOption = NULL
	)

[操作] 展開

引数

[in]	lpszName	対象ファイル。
[in,out]	_vb	読み出すサイズを設定して起きます。 実行後は抽出したサイズになっています。
[in]	lpszOption	追加オプション（省略可能）。

戻り値

0	正常終了
0以外	エラー発生

TnbArchiver.h の 181 行目に定義があります。

ExtractWithDirectory() [1/2]

int ExtractWithDirectory	(	const CStrVector &	vs,
		LPCTSTR	lpszOption = NULL
	)

[操作] 展開.

アーカイブファイルからファイルを展開します。

引数

vs	削除する名前。
lpszOption	追加オプション（省略可能）。

戻り値

0	成功
0以外	失敗。エラーコード。

TnbArchiver.h の 223 行目に定義があります。

ExtractWithDirectory() [2/2]

int ExtractWithDirectory	(	LPCTSTR	lpszName,
		LPCTSTR	lpszOption = NULL
	)

[操作] 展開.

アーカイブファイルからファイルを展開します。

引数

lpszName	展開する名前。ワイルドカードも可能。
lpszOption	追加オプション（省略可能）。

戻り値

0	成功
0以外	失敗。エラーコード。

TnbArchiver.h の 206 行目に定義があります。

GetTargetArchiveFile()

CStr GetTargetArchiveFile

(

void

)

const

[取得] 対象アーカイブ取得

覚え書き

SetTargetArchiveFile() で設定したファイル名が取得できます。

戻り値

アーカイブ名

TnbArchiver.h の 65 行目に定義があります。

SetTargetArchiveFile()

bool SetTargetArchiveFile

(

LPCTSTR

lpszArcFile

)

[設定] 対象アーカイブ指定

引数

lpszArcFile

対象アーカイブ

戻り値

ture	指定ファイルがないか、正しいアーカイブの場合。
false	指定ファイルが存在し、正しくないアーカイブの場合。

TnbArchiver.h の 77 行目に定義があります。

SetWorkDirectory()

void SetWorkDirectory

(

LPCTSTR

lpszWorkDir

)

[設定] 作業ディレクトリ指定

覚え書き

設定しない場合、システムのテンポラリディレクトリが使用されます。

引数

lpszWorkDir

ディレクトリ

TnbArchiver.h の 100 行目に定義があります。