SFUFileBuffer

ファイルバッファを表すクラスです。

#include <SFUFileBuffer.hpp>

class SFUFileBuffer : public SFUStreamBuffer;

typedef SFUFileBuffer&          SFUFileBufferRef;
typedef SFUFileBuffer*          SFUFileBufferPtr;
typedef SFUFileBuffer**         SFUFileBufferHandle;
typedef const SFUFileBuffer     ConstSFUFileBuffer;
typedef const SFUFileBuffer&    ConstSFUFileBufferRef;
typedef const SFUFileBuffer*    ConstSFUFileBufferPtr;
typedef const SFUFileBuffer**   ConstSFUFileBufferHandle;

継承図

協調図

解説

SFUFileBuffer はファイルバッファを表すクラスです。

参照

SFUFileStream

メンバ

コンストラクタ/デストラクタ
public	SFUFileBuffer	SFUFileBuffer クラスのコンストラクタです。
public	~SFUFileBuffer	SFUFileBuffer クラスのデストラクタです。

パブリック関数
public	Available	バッファに存在するデータ量を取得します。
public	Close	ファイルバッファをクローズします。
public	Exception (SFAException から継承)	エラーコードを取得/設定します。
public	Get	バッファ内のデータを取得します。
public	GetFile	内部の IFile インターフェイスを取得します。
public	IsEOS	ストリームバッファの終端に達したか判定します。
public	Open	ファイルバッファをオープンします。
public	Put	ファイルバッファにデータを追加します。
public	Seek	ファイルバッファの現在位置をシークします。
public	Tell	ファイルバッファの現在位置を返します。

プロテクト関数
public	Exception (SFAException から継承)	エラーコードを取得/設定します。
protected	InBase (SFUStreamBuffer から継承)	入力バッファの先頭アドレスを取得します。
protected	InEnd (SFUStreamBuffer から継承)	入力バッファの末尾アドレスを取得します。
protected	InPtr (SFUStreamBuffer から継承)	入力バッファの現在アドレスを取得します。
protected	OutBase (SFUStreamBuffer から継承)	出力バッファの先頭アドレスを取得します。
protected	OutEnd (SFUStreamBuffer から継承)	出力バッファの末尾アドレスを取得します。
protected	OutPtr (SFUStreamBuffer から継承)	出力バッファの現在アドレスを取得します。
protected	Overflow (SFUStreamBuffer から継承)	ストリームバッファのサイズを超えて書き込もうとした場合に呼び出されます。
protected	SetIn (SFUStreamBuffer から継承)	入力バッファの先頭アドレス、現在アドレス、末尾アドレスを設定します。
protected	SetOut (SFUStreamBuffer から継承)	出力バッファの先頭アドレス、現在アドレス、末尾アドレスを設定します。
protected	Underflow (SFUStreamBuffer から継承)	ストリームバッファのサイズを超えてデータを読み取ろうとした場合に呼び出されます。

型
	ERROR (SFUStreamBuffer から継承)	エラーを表す列挙型です。
	NO_ERROR (SFAException から継承)	エラーがないことを表す定数です。

SFUFileBuffer::SFUFileBuffer

SFUFileBuffer クラスのコンストラクタです。

[ public ]
SFUFileBuffer(Void);

SFUFileBuffer::~SFUFileBuffer

SFUFileBuffer クラスのデストラクタです。

[ public, virtual ]
~SFUFileBuffer(Void);

SFUFileBuffer::Available

バッファに存在するデータ量を取得します。

[ public, virtual ]
UInt32 Available(Void);

SFUFileBuffer::Close

ファイルバッファをクローズします。

[ public ]
Void Close(Void);

参照

SFUFileBuffer::Open

SFUFileBuffer::Get

バッファ内のデータを取得します。

[ public, virtual ]
UInt32 Get(
    VoidPtr pData   // データを取得するためのポインタ
    UInt32 nSize    // 取得するデータのサイズ
);

参照

SFUFileBuffer::Put

SFUFileBuffer::GetFile

内部の IFile インターフェイスを取得します。

[ public ]
SFUBrewPtr<SFBFile> GetFile(Void);

解説

SFUFileBuffer が使用している BREW IFile インターフェイスを取得します。

参照

SFBFile

SFUFileBuffer::IsEOS

ストリームバッファの終端に達したか判定します。

[ public, virtual ]
Bool IsEOS(Void);

SFUFileBuffer::Open

ファイルバッファをオープンします。

[ public ]
Void Open(
    ConstACharPtr filename               // ファイル名
    AEEOpenFileMode mode = _OFM_CREATE   // オープン モード
);

引数

filename

ファイル名を指定します。

mode

オープンモードを指定します。以下のいずれかの値を指定します。

_OFM_READ (読み取り専用でオープン。ファイルは作成しない。)
_OFM_READWRITE (読み取り/書き込み用にオープン。ファイルは作成しない。)
_OFM_APPEND (_OFM_READWRITE または FM_READWRITE モードと同様であるが、ファイルポインタをファイルの末尾に設定する。)
_OFM_CREATE (読み取り/書き込みモードでファイルを作成する。ファイルがすでに存在する場合はエラーが生成され、ファイルはオープンされない。)

参照

SFUFileBuffer::Close

SFUFileBuffer::Put

ファイルバッファにデータを追加します。

[ public, virtual ]
UInt32 Put(
    ConstVoidPtr pData   // 追加するデータのポインタ
    UInt32 nSize         // 追加するバイト数
);

参照

SFUFileBuffer::Get

SFUFileBuffer::Seek

ファイルバッファの現在位置をシークします。

[ public, virtual ]
UInt32 Seek(
    SInt32 offset                   // シークするオフセット値
    SFABaseStream::SEEK_DIR dir     // シークする基点
    SFABaseStream::SEEK_MODE mode   // シークするモード
);

解説

SFUStreamBuffer::Seek を参照してください。

参照

SFUFileBuffer::Tell

SFUFileBuffer::Tell

ファイルバッファの現在位置を返します。

[ public, virtual ]
UInt32 Tell(
    SFABaseStream::SEEK_MODE mode   // 入力バッファ/出力バッファ
);

引数

mode

入力バッファと出力バッファのどちらの現在位置を取得するのか指定します。次のいずれかの値を指定します。

SFABaseStream::MODE_READ (入力バッファの現在位置を取得)

SFABaseStream::MODE_WRITE (出力バッファの現在位置を取得)

参照

SFUFileBuffer::Seek