SFBFileMgr

IFileMgr インターフェースのラッパークラスです。

#include <SFBFileMgr.h.hpp>

class SFBFileMgr : public SFBBase;

SFMTYPEDEFWRAPPER(SFBFileMgr)

継承図

バージョン

BREW 2.0	BREW 2.1	BREW 3.0	BREW 3.1
○	○	○	○

参照

BREW API IFileMgr

メンバ

パブリック関数
`SFCError`	CheckPathAccess( `ACharConstPtr` path , `UInt32` desiredRights , `UInt32Ptr` actualRights ) CheckPathAccess( `SFXAnsiStringConstRef` path , `UInt32` desiredRights , `UInt32Ptr` actualRights ) コール側が入力パスへの特定のアクセス権を持っているかどうかチェックします。
`SFCError`	EnumInit( `ACharConstPtr` dirName , `Bool` dir = false ) EnumInit( `SFXAnsiStringConstRef` dirName , `Bool` dir = false ) 指定したディレクトリ内のファイルやディレクトリを列挙するための初期化を行います。
`Bool`	EnumNext( `AEEFileInfoPtr` info ) 次のファイルやディレクトリの情報を取得します。
`Bool`	EnumNextEx( `AEEFileInfoExPtr` infoEx ) 次のファイルやディレクトリの拡張情報を取得します。
`SFCError`	GetFileUseInfo( `AEEFileUseInfoPtr` useInfo ) モジュールのファイル使用情報を取得します。
`AEEFileUseInfo`	GetFileUseInfo( `Void` ) モジュールのファイル使用情報を取得します。
`UInt32`	GetFreeSpace( `UInt32Ptr` total = null ) ファイルシステムで現在使用可能な空きバイト数を取得します。
`SFCError`	GetInfo( `ACharConstPtr` fileName , `AEEFileInfoPtr` info ) GetInfo( `SFXAnsiStringConstRef` fileName , `AEEFileInfoPtr` info ) ファイル名で指定したファイルの情報を取得します。
`AEEFileInfo`	GetInfo( `SFXAnsiStringConstRef` fileName ) ファイル名で指定したファイルの情報を取得します。
`SFCError`	GetInfoEx( `ACharConstPtr` fileName , `AEEFileInfoExPtr` infoEx ) GetInfoEx( `SFXAnsiStringConstRef` fileName , `AEEFileInfoExPtr` infoEx ) ファイル名で指定したファイルの拡張情報を取得します。
`SFCError`	GetLastError( `Void` ) アプレットで実行したファイル操作が失敗し、失敗の理由を取得する必要がある場合に使用します。
`SFCError`	MkDir( `ACharConstPtr` dirName ) MkDir( `SFXAnsiStringConstRef` dirName ) 指定されたディレクトリ名のディレクトリを作成します。
static `SFBFileMgrSmp`	NewInstance( `Void` ) SFBFileMgr クラスのインスタンスを生成します。
`SFBFileSmp`	OpenFile( `ACharConstPtr` fileName , `AEEOpenFileMode` mode ) OpenFile( `SFXAnsiStringConstRef` fileName , `AEEOpenFileMode` mode ) 指定したモードでファイルをオープンします。
`SFCError`	Remove( `ACharConstPtr` fileName ) Remove( `SFXAnsiStringConstRef` fileName ) ファイル名で指定されたファイルを削除します。
`SFCError`	Rename( `ACharConstPtr` srcFileName , `ACharConstPtr` destFileName ) Rename( `SFXAnsiStringConstRef` srcFileName , `SFXAnsiStringConstRef` destFileName ) ファイルやディレクトリの名前を変更します。
`SFCError`	ResolvePath( `ACharConstPtr` path , `ACharPtr` canonicalPath , `UInt32Ptr` canonicalPathLen ) ResolvePath( `SFXAnsiStringConstRef` path , `SFXAnsiStringPtr` canonicalPath ) ファイルシステムのパスを BREW の標準形式に解決します。
`SFCError`	RmDir( `ACharConstPtr` dirName ) RmDir( `SFXAnsiStringConstRef` dirName ) 指定されたディレクトリを削除します。
`SFCError`	SetDescription( `ACharConstPtr` fileName , `WCharPtr` description ) SetDescription( `SFXAnsiStringConstRef` fileName , `SFXWideStringPtr` description ) 拡張ファイル情報の一部であるファイルの説明を設定します。
`SFCError`	Test( `ACharConstPtr` name ) Test( `SFXAnsiStringConstRef` name ) 指定したファイルまたはディレクトリが存在するかどうかをチェックします。
`SFCError`	UnUse( `ACharConstPtr` fileName ) UnUse( `SFXAnsiStringConstRef` fileName ) 指定したファイルを使用するクラスのリストから呼び出し側アプリの ClassID を削除します。
`SFCError`	Use( `ACharConstPtr` fileName ) Use( `SFXAnsiStringConstRef` fileName ) 指定したファイルを使用するクラスのリストに、呼び出し側アプリの ClassID を追加します。

SFBFileMgr::CheckPathAccess

コール側が入力パスへの特定のアクセス権を持っているかどうかチェックします。

[ public ]
SFCError CheckPathAccess(
    ACharConstPtr path       // チェックするパス
    UInt32 desiredRights     // 希望する権限
    UInt32Ptr actualRights   // 実際の権限が格納される。null の場合は無効
);

[ public ]
SFCError CheckPathAccess(
    SFXAnsiStringConstRef path   // チェックするパス
    UInt32 desiredRights         // 希望する権限
    UInt32Ptr actualRights       // 実際の権限が格納される。null の場合は無効
);

引数

desiredRights

以下のアクセスを指定するビット幅の OR です。

AEEFP_READ : パスの読み取りアクセスを希望
AEEFP_WRITE : パスの書き込みアクセスを希望
AEEFP_CREATE : パスの作成アクセスを希望
AEEFP_DELETE : パスの削除アクセスを希望

戻り値

成功したとき : SFERR_NO_ERROR
アクセスが拒否されたとき : EPRIVLEVEL
パスを解決またはチェックできないとき : EBADFILENAME

バージョン

この関数は、BREW 3.0 から使用可能です。

参照

BREW API IFILEMGR_CheckPathAccess | BREW API IFILEMGR_ResolvePath | BREW API IFILEMGR_CheckPrivLevel | SFBFileMgr::ResolvePath | SFBShell::CheckPrivLevel

SFBFileMgr::EnumInit

指定したディレクトリ内のファイルやディレクトリを列挙するための初期化を行います。

[ public ]
SFCError EnumInit(
    ACharConstPtr dirName   // ディレクトリ名
    Bool dir = false        // true の場合、ディレクトリを列挙
);

[ public ]
SFCError EnumInit(
    SFXAnsiStringConstRef dirName   // ディレクトリ名
    Bool dir = false                // true の場合、ディレクトリを列挙
);

戻り値

成功したとき : SFERR_NO_ERROR
失敗したとき : SFERR_FAILED

参照

BREW API IFILEMGR_EnumInit | SFBFileMgr::EnumNext

SFBFileMgr::EnumNext

次のファイルやディレクトリの情報を取得します。

[ public ]
Bool EnumNext(
    AEEFileInfoPtr info   // 情報を受け取る領域を指すポインター
);

戻り値

成功したとき : SFERR_NO_ERROR
失敗したとき : SFERR_FAILED

使用例

ディレクトリ内にある次のファイルの情報を取得し、ファイル名をログに表示します。

SFBFileMgrSmp   fileMgr = SFBFileMgr::NewInstance();
FileInfo        info    = {0};

// ファイルを列挙するための初期化を行う
if (fileMgr->EnumInit("new_dir", false) == SUCCESS) {

    // 次のファイルの情報を取得する
    fileMgr->EnumNext(&info);

    // ファイル名をログに表示する
    DBGPRINTF("file name : %s", info.szName);
}

参照

BREW API IFILEMGR_EnumNext | SFBFileMgr::EnumInit | FileInfo

SFBFileMgr::EnumNextEx

次のファイルやディレクトリの拡張情報を取得します。

[ public ]
Bool EnumNextEx(
    AEEFileInfoExPtr infoEx   // 拡張情報を受け取る領域を指すポインター
);

戻り値

正常終了したとき : true
失敗したとき : false

使用例

ディレクトリ内にある次のファイルの拡張情報を取得し、ファイル名をログに表示します。

SFBFileMgrSmp       fileMgr          = SFBFileMgr::NewInstance();
AEEFileInfoEx       infoEx           = {0};
AChar               fileName[128]    = {0};
WChar               description[128] = {0};
AEECLSID            cls[32]          = {0};

// ファイルの列挙を行うための初期化を行う
if (fileMgr->EnumInit("new_dir", false) == SUCCESS) {

    // AEEFileInfoEx 構造体を初期化する
    infoEx.nStructSize      = sizeof(AEEFileInfoEx);
    infoEx.pszFile          = fileName;
    infoEx.nMaxFile         = 128;
    infoEx.pszDescription   = description;
    infoEx.nDescriptionSize = 128 * sizeof(WChar);
    infoEx.pClasses         = cls;
    infoEx.nClassesSize     = 32 * sizeof(AEECLSID);

    // 次のファイルの情報を取得する
    fileMgr->numNextEx(&infoEx);

    // ファイル名をログに表示する
    TRACE("file name : %s", infoEx.pszFile);
}

参照

BREW API IFILEMGR_EnumNextEx | SFBFileMgr::EnumInit | AEEFileInfoEx

SFBFileMgr::GetFileUseInfo

モジュールのファイル使用情報を取得します。

[ public ]
SFCError GetFileUseInfo(
    AEEFileUseInfoPtr useInfo   // ファイル使用情報を受け取る領域を指すポインター
);

[ public ]
AEEFileUseInfo GetFileUseInfo(Void);

戻り値

成功したとき : SFERR_NO_ERROR
メモリ不足のとき : SFERR_NO_MEMORY
失敗したとき : SFERR_FAILED

使用例

ファイル使用情報を取得する

SFBFileMgrSmp       fileMgr = SFBFileMgr::NewInstance();
AEEFileUseInfo      info    = {0};

// ファイル使用情報を取得する
fileMgr->GetFileUseInfo(&info);

参照

BREW API IFILEMGR_GetFileUseInfo | AEEFileUseInfo

SFBFileMgr::GetFreeSpace

ファイルシステムで現在使用可能な空きバイト数を取得します。

[ public ]
UInt32 GetFreeSpace(
    UInt32Ptr total = null   // ファイルシステム内の合計空き容量を受け取る領域を指すポインター
);

参照

BREW API IFILEMGR_GetFreeSpace

SFBFileMgr::GetInfo

ファイル名で指定したファイルの情報を取得します。

[ public ]
SFCError GetInfo(
    ACharConstPtr fileName   // ファイル名
    AEEFileInfoPtr info      // ファイルの情報を受け取る領域を指すポインター
);

[ public ]
SFCError GetInfo(
    SFXAnsiStringConstRef fileName   // ファイル名
    AEEFileInfoPtr info              // ファイルの情報を受け取る領域を指すポインター
);

[ public ]
AEEFileInfo GetInfo(
    SFXAnsiStringConstRef fileName   // ファイル名
);

戻り値

成功したとき : SFERR_NO_ERROR
失敗したとき : SFERR_FAILED

使用例

ファイルの情報を取得する

SFBFileMgrSmp   fileMgr = SFBFileMgr::NewInstance();
FileInfo        info    = {0};

// ファイルの情報を取得する
fileMgr->GetInfo("sample.txt", &info);

参照

BREW API IFILEMGR_GetInfo | FileInfo | SFBFile::GetInfoEx

SFBFileMgr::GetInfoEx

ファイル名で指定したファイルの拡張情報を取得します。

[ public ]
SFCError GetInfoEx(
    ACharConstPtr fileName    // ファイル名
    AEEFileInfoExPtr infoEx   // ファイルの拡張情報を受け取る領域を指すポインター
);

[ public ]
SFCError GetInfoEx(
    SFXAnsiStringConstRef fileName   // ファイル名
    AEEFileInfoExPtr infoEx          // ファイルの拡張情報を受け取る領域を指すポインター
);

戻り値

成功したとき : SFERR_NO_ERROR
メモリ不足のとき : SFERR_NO_MEMORY
失敗したとき : SFERR_FAILED

使用例

ファイルの拡張情報を取得します。

SFBFileMgrSmp       fileMgr          = SFBFileMgr::NewInstance();
AEEFileInfoEx       infoEx           = {0};
AChar               fileName[128]    = {0};
WChar               description[128] = {0};
AEECLSID            cls[32]          = {0};

// AEEFileInfoEx 構造体を初期化する
infoEx.nStructSize      = sizeof(AEEFileInfoEx);
infoEx.pszFile          = fileName;
infoEx.nMaxFile         = 128;
infoEx.pszDescription   = description;
infoEx.nDescriptionSize = 128 * sizeof(WChar);
infoEx.pClasses         = cls;
infoEx.nClassesSize     = 32 * sizeof(AEECLSID);

// ファイルの拡張情報を取得する
fileMgr->GetInfoEx("sample.txt", &infoEx);

参照

BREW API IFILEMGR_GetInfoEx | AEEFileInfoEx | SFBFile::GetInfoEx

SFBFileMgr::GetLastError

アプレットで実行したファイル操作が失敗し、失敗の理由を取得する必要がある場合に使用します。

[ public ]
SFCError GetLastError(Void);

戻り値

成功したとき : SFERR_NO_ERROR
ファイルが存在するとき : EFILEEXISTS
ファイルが存在しないとき : EFILENOEXISTS
ディレクトリが空でないとき : EDIRNOTEMPTY
ファイル名が正しくないとき : EBADFILENAME
シーク位置が正しくないとき : EBADSEEKPOS
ファイルの終わりのとき : EFILEEOF
ファイルシステムに空きがないとき : EFSFULL
ファイルが既に開いているとき : EFILEOPEN

参照

BREW API IFILEMGR_GetLastError

SFBFileMgr::MkDir

指定されたディレクトリ名のディレクトリを作成します。

[ public ]
SFCError MkDir(
    ACharConstPtr dirName   // ディレクトリ名
);

[ public ]
SFCError MkDir(
    SFXAnsiStringConstRef dirName   // ディレクトリ名
);

戻り値

成功したとき : SFERR_NO_ERROR
失敗したとき : SFERR_FAILED
ファイルシステム内に空き容量がないとき : EFSFULL

使用例

ディレクトリを作成します。

SFBFileMgrSmp  fileMgr = SFBFileMgr::NewInstance();

// ディレクトリを作成する
fileMgr->MkDir("new_dir");

参照

BREW API IFILEMGR_MkDir | SFBFileMgr::RmDir

SFBFileMgr::NewInstance

SFBFileMgr クラスのインスタンスを生成します。

[ public, static ]
SFBFileMgrSmp NewInstance(Void);

SFBFileMgr::OpenFile

指定したモードでファイルをオープンします。

[ public ]
SFBFileSmp OpenFile(
    ACharConstPtr fileName   // ファイル名
    AEEOpenFileMode mode     // オープンモード
);

[ public ]
SFBFileSmp OpenFile(
    SFXAnsiStringConstRef fileName   // ファイル名
    AEEOpenFileMode mode             // オープンモード
);

使用例

ファイルを作成します。

SFBFileMgrSmp  fileMgr = SFBFileMgr::NewInstance();
SFBFileSmp     file;

// ファイルを作成する
file = fileMgr->OpenFile("sample.txt",_OFM_CREATE);

if (file != null) {

    // SophiaFramework のスマートポインター ( SFXBrewPointer ) を使用すると
    // ファイルのクローズは自動的に行われる
    // もし、手動でクローズする場合は、            
    //
    // file.Release();
    //
    // と記述する
}

参照

BREW API IFILEMGR_OpenFile | SFBFileMgr::MkDir

SFBFileMgr::Remove

ファイル名で指定されたファイルを削除します。

[ public ]
SFCError Remove(
    ACharConstPtr fileName   // ファイル名
);

[ public ]
SFCError Remove(
    SFXAnsiStringConstRef fileName   // ファイル名
);

戻り値

成功したとき : SFERR_NO_ERROR
失敗したとき : SFERR_FAILED

使用例

ファイルを削除します。

SFBFileMgrSmp  fileMgr = SFBFileMgr::NewInstance();

// ファイルを削除する
fileMgr->Remove("sample.txt");

参照

BREW API IFILEMGR_Remove

SFBFileMgr::Rename

ファイルやディレクトリの名前を変更します。

[ public ]
SFCError Rename(
    ACharConstPtr srcFileName    // 変更前の名前
    ACharConstPtr destFileName   // 変更後の名前
);

[ public ]
SFCError Rename(
    SFXAnsiStringConstRef srcFileName    // 変更前の名前
    SFXAnsiStringConstRef destFileName   // 変更後の名前
);

戻り値

成功したとき : SFERR_NO_ERROR
失敗したとき : SFERR_FAILED

使用例

ディレクトリ名を変更します。

SFBFileMgrSmp  fileMgr = SFBFileMgr::NewInstance();

// ディレクトリ名を変更する
fileMgr->Rename("tmp_dir","new_dir");

参照

BREW API IFILEMGR_Rename | SFBFileMgr::EnumNext

SFBFileMgr::ResolvePath

ファイルシステムのパスを BREW の標準形式に解決します。

[ public ]
SFCError ResolvePath(
    ACharConstPtr path           // 解決するパス
    ACharPtr canonicalPath       // BREW 標準パスを格納する出力バッファ。 null であることも可能
    UInt32Ptr canonicalPathLen   // 入力時、このパラメータは canonicalPath[] に書き込み可能な最大バイト数を示す
                                 // 終了時、このパラメータは canonicalPath[] に書き込まれたバイト数を格納する
);

[ public ]
SFCError ResolvePath(
    SFXAnsiStringConstRef path       // 解決するパス
    SFXAnsiStringPtr canonicalPath   // BREW 標準パスを格納する出力バッファ
);

戻り値

成功したとき : SFERR_NO_ERROR
引数が不正なとき : SFERR_INVALID_PARAM
失敗したとき : SFERR_FAILED
path が null 以外であるが、解決されたパスを格納するには *canonicalPathLen が小さ過ぎるとき : EBUFFERTOOSMALL

バージョン

この関数は、BREW 3.0 から使用可能です。

参照

BREW API IFILEMGR_ResolvePath | BREW API IFILEMGR_CheckPathAccess

SFBFileMgr::RmDir

指定されたディレクトリを削除します。

[ public ]
SFCError RmDir(
    ACharConstPtr dirName   // ディレクトリ名
);

[ public ]
SFCError RmDir(
    SFXAnsiStringConstRef dirName   // ディレクトリ名
);

戻り値

成功したとき : SFERR_NO_ERROR
メモリ不足のとき : SFERR_NO_MEMORY
失敗したとき : SFERR_FAILED

使用例

ディレクトリを削除します。

SFBFileMgrSmp  fileMgr = SFBFileMgr::NewInstance();

// ディレクトリを削除する
fileMgr->RmDir("tmp_dir");

参照

BREW API IFILEMGR_RmDir | SFBFileMgr::MkDir

SFBFileMgr::SetDescription

拡張ファイル情報の一部であるファイルの説明を設定します。

[ public ]
SFCError SetDescription(
    ACharConstPtr fileName   // ファイル名
    WCharPtr description     // ファイルの説明
);

[ public ]
SFCError SetDescription(
    SFXAnsiStringConstRef fileName   // ファイル名
    SFXWideStringPtr description     // ファイルの説明
);

戻り値

成功したとき : SFERR_NO_ERROR
メモリ不足のとき : SFERR_NO_MEMORY
失敗したとき : SFERR_FAILED

使用例

ファイルの説明を設定します。

SFBFileMgrSmp       fileMgr = SFBFileMgr::NewInstance();
SFXWideString       description("Sample File");

// ファイルの説明を設定する
fileMgr->SetDescription("sample.txt", &description);

参照

BREW API IFILEMGR_SetDescription | SFBFileMgr::EnumInit

SFBFileMgr::Test

指定したファイルまたはディレクトリが存在するかどうかをチェックします。

[ public ]
SFCError Test(
    ACharConstPtr name   // ファイルまたはディレクトリ名
);

[ public ]
SFCError Test(
    SFXAnsiStringConstRef name   // ファイルまたはディレクトリ名
);

戻り値

指定されたファイルまたはディレクトリが存在するとき : SFERR_NO_ERROR
それ以外のとき : SFERR_FAILED

使用例

指定したファイルが存在するかどうかをチェックします。

SFBFileMgrSmp       fileMgr = SFBFileMgr::NewInstance();

// 指定したファイルが存在するかどうかをチェックする
if (fileMgr->Test("sample.txt") == SUCCESS ) {
    // 指定したファイルが存在する場合の処理を記載する
    //                 ・
    //                 ・
    //                 ・
}

参照

BREW API IFILEMGR_Test

SFBFileMgr::UnUse

指定したファイルを使用するクラスのリストから呼び出し側アプリの ClassID を削除します。

[ public ]
SFCError UnUse(
    ACharConstPtr fileName   // ファイル名を含む null 終結文字列
);

[ public ]
SFCError UnUse(
    SFXAnsiStringConstRef fileName   // ファイル名を含む null 終結文字列
);

戻り値

成功したとき : SFERR_NO_ERROR
メモリ不足のとき : SFERR_NO_MEMORY
失敗したとき : SFERR_FAILED

解説

最後のアプリが、指定したファイルが不要であると示した場合や、 SFBFileMgr::Remove が呼び出された場合に、このファイルは削除されます。

参照

BREW API IFILEMGR_UnUse | SFBFileMgr::Use | SFBFileMgr::GetInfoEx | AEEFileInfoEx

SFBFileMgr::Use

指定したファイルを使用するクラスのリストに、呼び出し側アプリの ClassID を追加します。

[ public ]
SFCError Use(
    ACharConstPtr fileName   // ファイル名
);

[ public ]
SFCError Use(
    SFXAnsiStringConstRef fileName   // ファイル名
);

戻り値

成功したとき : SFERR_NO_ERROR
メモリ不足のとき : SFERR_NO_MEMORY
失敗したとき : SFERR_FAILED

解説

最後のアプリが、指定したファイルが不要であると示した場合や SFBFileMgr::Remove が呼び出された場合に、このファイルは削除されます。

参照

BREW API IFILEMGR_Use | SFBFileMgr::UnUse | SFBFileMgr::GetInfoEx | AEEFileInfoEx