SFXOutputStream

出力ストリームを表す基底クラスです。

#include <SFXOutputStream.h.hpp>

class SFXOutputStream : public SFXStream;

SFMTYPEDEFCLASS(SFXOutputStream)

継承図

データの種類に応じて、SFXOutputStream クラスを継承する SFXAnsiStringStreamWriter クラス、SFXWideStringStreamWriter クラス、SFXBinaryStreamWriter クラスを使い分けます。

コンストラクタ/デストラクタ
SFXOutputStream( `Void` ) SFXOutputStream クラスのコンストラクタです。
~SFXOutputStream( `Void` ) SFXOutputStream クラスのデストラクタです。

パブリック関数
`SFCError`	Flush( `Void` ) Flush( `CallbackSPP` spp , `VoidPtr` reference ) 書き込んだデータをフラッシュします。
`UInt32`	GetWritableSize( `Void` ) 書き込み可能なデータサイズを取得します。
`SFCError`	Write( `SFXBufferConstRef` buffer ) Write( `VoidConstPtr` buffer , `UInt32` size ) データを出力ストリームに書き込みます。
`Void`	Cancel( `Void` ) (SFXStream から継承) ストレージクラスの Cancel 関数を呼び出します。登録したコールバック関数もキャンセルします。
`SFCError`	ResetTrigger( `Void` ) (SFXStream から継承) コールバック関数が呼ばれるトリガーをリセットします。
`SFCError`	SetTrigger( `UInt32` size ) (SFXStream から継承) SetTrigger( `VoidConstPtr` buffer , `UInt32` size ) (SFXStream から継承) SetTrigger( `SFXBufferConstRef` buffer ) (SFXStream から継承) コールバック関数が呼ばれるトリガーを設定します。
`Bool`	Triggers( `Void` ) (SFXStream から継承) トリガーによりコールバック関数が呼ばれたか判定します。

型
CallbackSPP (SFXStream から継承) コールバック関数を表す型です。

SFXOutputStream::SFXOutputStream

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

[ protected, explicit ]
SFXOutputStream(Void);

SFXOutputStream::~SFXOutputStream

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

[ public, virtual ]
virtual ~SFXOutputStream(Void);

SFXOutputStream::Flush

書き込んだデータをフラッシュします。

[ public, virtual ]
SFCError Flush(Void);

[ public, virtual ]
SFCError Flush(
    CallbackSPP spp     // コールバック関数
    VoidPtr reference   // コールバック関数へ渡すデータ
);

Flush 関数は純粋仮想関数です。

SFXOutputStream::GetWritableSize

書き込み可能なデータサイズを取得します。

[ public, virtual, const ]
UInt32 GetWritableSize(Void);

GetWritableSize 関数は純粋仮想関数です。

SFXOutputStream::Write

データを出力ストリームに書き込みます。

[ public, virtual ]
SFCError Write(
    SFXBufferConstRef buffer   // 書き込むデータ
);

[ public, virtual ]
SFCError Write(
    VoidConstPtr buffer   // 書き込むデータ
    UInt32 size           // 書き込むデータのサイズ
);

Write 関数は純粋仮想関数です。