SFXBinaryStreamWriter

出力ストリームへデータをバイナリ列で書き込むためのクラスです。

#include <SFXBinaryStreamWriter.h.hpp>

class SFXBinaryStreamWriter : public SFXStreamWriter, public SFXBinaryStream;

SFMTYPEDEFCLASS(SFXBinaryStreamWriter)

継承図

協調図

解説

ファイルや TCP ソケットなどのストリームへデータをバイナリ列で書き込むときに使います。

参照

SFXAnsiStringStreamWriter | SFXWideStringStreamWriter

メンバ

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

パブリック関数
`SFCError`	WriteAChar( `ACharConstPtr` string , `SInt32` length = -1 ) 指定した長さの AChar 型文字列を出力ストリームに書き込みます。
`SFCError`	WriteBool( `Bool` param ) データを Bool 値として出力ストリームに書き込みます。
`SFCError`	WriteFloat32( `Float32` param ) データを Float32 値として出力ストリームに書き込みます。
`SFCError`	WriteFloat64( `Float64` param ) データを Float64 値として出力ストリームに書き込みます。
`SFCError`	WriteSFXAnsiString( `SFXAnsiStringConstRef` param ) データを SFXAnsiString 型文字列として出力ストリームに書き込みます。
`SFCError`	WriteSFXWideString( `SFXWideStringConstRef` param ) データを SFXWideString 型文字列として出力ストリームに書き込みます。
`SFCError`	WriteSInt08( `SInt08` param ) データを SInt08 値として出力ストリームに書き込みます。
`SFCError`	WriteSInt16( `SInt16` param ) データを SInt16 値として出力ストリームに書き込みます。
`SFCError`	WriteSInt32( `SInt32` param ) データを SInt32 値として出力ストリームに書き込みます。
`SFCError`	WriteSInt64( `SInt64` param ) データを SInt64 値として出力ストリームに書き込みます。
`SFCError`	WriteUInt08( `UInt08` param ) データを UInt08 値として出力ストリームに書き込みます。
`SFCError`	WriteUInt16( `UInt16` param ) データを UInt16 値として出力ストリームに書き込みます。
`SFCError`	WriteUInt32( `UInt32` param ) データを UInt32 値として出力ストリームに書き込みます。
`SFCError`	WriteUInt64( `UInt64` param ) データを UInt64 値として出力ストリームに書き込みます。
`SFCError`	WriteWChar( `WCharConstPtr` string , `SInt32` length = -1 ) 指定した長さの WChar 型文字列を出力ストリームに書き込みます。
`SFXBinaryStreamWriterRef`	operator<<( `SFXBinaryStreamWriterRef` left , `SFXBufferConstRef` right ) operator<<( `SFXBinaryStreamWriterRef` left , `SFXWideStringConstRef` right ) operator<<( `SFXBinaryStreamWriterRef` left , `SFXAnsiStringConstRef` right ) operator<<( `SFXBinaryStreamWriterRef` left , `WCharConstPtr` right ) operator<<( `SFXBinaryStreamWriterRef` left , `ACharConstPtr` right ) operator<<( `SFXBinaryStreamWriterRef` left , `Float64` right ) operator<<( `SFXBinaryStreamWriterRef` left , `Float32` right ) operator<<( `SFXBinaryStreamWriterRef` left , `UInt64` right ) operator<<( `SFXBinaryStreamWriterRef` left , `SInt64` right ) operator<<( `SFXBinaryStreamWriterRef` left , `UInt32` right ) operator<<( `SFXBinaryStreamWriterRef` left , `SInt32` right ) operator<<( `SFXBinaryStreamWriterRef` left , `UInt16` right ) operator<<( `SFXBinaryStreamWriterRef` left , `SInt16` right ) operator<<( `SFXBinaryStreamWriterRef` left , `UInt08` right ) operator<<( `SFXBinaryStreamWriterRef` left , `SInt08` right ) operator<<( `SFXBinaryStreamWriterRef` left , `SFXBinaryStreamWriter::ManipulatorSPP` right ) 出力ストリームに書き込みます。
`Void`	Attach( `SFXOutputStreamPtr` stream ) (SFXStreamWriter から継承) SFXOutputStream クラスのインスタンスの動作や管理権限を SFXStreamWriter クラスのインスタンスにデリゲート(委譲)します。
`Void`	Cancel( `Void` ) (SFXStreamWriter から継承) ストレージクラスの Cancel 関数を呼び出します。登録したコールバック関数もキャンセルします。
`SFXOutputStreamPtr`	Detach( `Void` ) (SFXStreamWriter から継承) SFXStreamWriter クラスのインスタンスの動作と管理権限を SFXOutputStream クラスのインスタンスにデリゲート(委譲)します。
`SFCError`	Flush( `Void` ) (SFXStreamWriter から継承) Flush( `CallbackSPP` spp , `VoidPtr` reference ) (SFXStreamWriter から継承) 書き込んだデータをフラッシュします。
`EndianEnum`	GetEndian( `Void` ) (SFXBinaryStream から継承) エンディアンを取得します。
`UInt32`	GetWritableSize( `Void` ) (SFXStreamWriter から継承) 書き込み可能なデータサイズを取得します。
`Void`	Release( `Void` ) (SFXStreamWriter から継承) ストリームを解放します。
`SFCError`	ResetTrigger( `Void` ) (SFXStreamWriter から継承) コールバック関数が呼ばれるトリガーをリセットします。
`Void`	SetEndian( `EndianEnum` param ) (SFXBinaryStream から継承) エンディアンを設定します。
`SFCError`	SetTrigger( `UInt32` size ) (SFXStreamWriter から継承) SetTrigger( `VoidConstPtr` buffer , `UInt32` size ) (SFXStreamWriter から継承) SetTrigger( `SFXBufferConstRef` buffer ) (SFXStreamWriter から継承) コールバック関数が呼ばれるトリガーを設定します。
`Bool`	Triggers( `Void` ) (SFXStreamWriter から継承) トリガーによりコールバック関数が呼ばれたか判定します。
`SFCError`	Write( `SFXBufferConstRef` buffer ) (SFXStreamWriter から継承) Write( `VoidConstPtr` buffer , `UInt32` size ) (SFXStreamWriter から継承) ストリームにデータを書き込みます。
`Void`	big( `SFXBinaryStreamRef` stream ) (SFXBinaryStream から継承) エンディアンをビッグエンディアンに設定するマニピュレータです。
`Void`	little( `SFXBinaryStreamRef` stream ) (SFXBinaryStream から継承) エンディアンをリトルエンディアンに設定するマニピュレータです。

型
CallbackSPP (SFXStream から継承) コールバック関数を表す型です。
EndianEnum (SFXBinaryStream から継承) エンディアンを表す型です。
ManipulatorSPP (SFXBinaryStream から継承) SFXBinaryStream クラスのマニピュレータを表す型です。

SFXBinaryStreamWriter::SFXBinaryStreamWriter

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

[ public, explicit ]
SFXBinaryStreamWriter(Void);

SFXBinaryStreamWriter::WriteAChar

指定した長さの AChar 型文字列を出力ストリームに書き込みます。

[ public ]
SFCError WriteAChar(
    ACharConstPtr string   // AChar 型文字列
    SInt32 length = -1     // 文字列の長さ
);

引数

string: 書き込む AChar 型文字列です。
length: 書き込む文字列の長さです。-1 を指定すると '\0' までの文字列を ('\0' を含めて) 書き込みます。

戻り値

成功したとき : SFERR_NO_ERROR
ストリームが設定されていないとき : SFERR_INVALID_STATE
引数が不正なとき : SFERR_INVALID_PARAM
メモリ不足のとき : SFERR_NO_MEMORY
書き込めないとき : SFERR_FAILED

解説

length パラメータで指定した長さの AChar 型文字列を書き込み、最後に '\0' を書き込みます。

参照

SFXBinaryStreamWriter::WriteWChar | SFXBinaryStreamWriter::WriteSFXAnsiString | SFXBinaryStreamWriter::WriteSFXWideString

SFXBinaryStreamWriter::WriteBool

データを Bool 値として出力ストリームに書き込みます。

[ public ]
SFCError WriteBool(
    Bool param   // 書き込む値
);

戻り値

成功したとき : SFERR_NO_ERROR
ストリームが設定されていないとき : SFERR_INVALID_STATE
引数が不正なとき : SFERR_INVALID_PARAM
書き込めないとき : SFERR_FAILED

参照

SFXBinaryStreamWriter::WriteSInt08 | SFXBinaryStreamWriter::WriteUInt08

SFXBinaryStreamWriter::WriteFloat32

データを Float32 値として出力ストリームに書き込みます。

[ public ]
SFCError WriteFloat32(
    Float32 param   // 書き込む値
);

戻り値

成功したとき : SFERR_NO_ERROR
ストリームが設定されていないとき : SFERR_INVALID_STATE
引数が不正なとき : SFERR_INVALID_PARAM
書き込めないとき : SFERR_FAILED

参照

SFXBinaryStreamWriter::WriteFloat64

SFXBinaryStreamWriter::WriteFloat64

データを Float64 値として出力ストリームに書き込みます。

[ public ]
SFCError WriteFloat64(
    Float64 param   // 書き込む値
);

戻り値

成功したとき : SFERR_NO_ERROR
ストリームが設定されていないとき : SFERR_INVALID_STATE
引数が不正なとき : SFERR_INVALID_PARAM
書き込めないとき : SFERR_FAILED

参照

SFXBinaryStreamWriter::WriteFloat32

SFXBinaryStreamWriter::WriteSFXAnsiString

データを SFXAnsiString 型文字列として出力ストリームに書き込みます。

[ public ]
SFCError WriteSFXAnsiString(
    SFXAnsiStringConstRef param   // 文字列
);

戻り値

成功したとき : SFERR_NO_ERROR
ストリームが設定されていないとき : SFERR_INVALID_STATE
引数が不正なとき : SFERR_INVALID_PARAM
メモリ不足のとき : SFERR_NO_MEMORY
書き込めないとき : SFERR_FAILED

解説

最後に '\0' を書き込みます。

参照

SFXBinaryStreamWriter::WriteAChar | SFXBinaryStreamWriter::WriteWChar | SFXBinaryStreamWriter::WriteSFXWideString

SFXBinaryStreamWriter::WriteSFXWideString

データを SFXWideString 型文字列として出力ストリームに書き込みます。

[ public ]
SFCError WriteSFXWideString(
    SFXWideStringConstRef param   // 文字列
);

戻り値

成功したとき : SFERR_NO_ERROR
ストリームが設定されていないとき : SFERR_INVALID_STATE
引数が不正なとき : SFERR_INVALID_PARAM
メモリ不足のとき : SFERR_NO_MEMORY
書き込めないとき : SFERR_FAILED

解説

最後に '\0' を書き込みます。

参照

SFXBinaryStreamWriter::WriteAChar | SFXBinaryStreamWriter::WriteWChar | SFXBinaryStreamWriter::WriteSFXAnsiString

SFXBinaryStreamWriter::WriteSInt08

データを SInt08 値として出力ストリームに書き込みます。

[ public ]
SFCError WriteSInt08(
    SInt08 param   // 書き込む値
);

戻り値

成功したとき : SFERR_NO_ERROR
ストリームが設定されていないとき : SFERR_INVALID_STATE
引数が不正なとき : SFERR_INVALID_PARAM
書き込めないとき : SFERR_FAILED

参照

SFXBinaryStreamWriter::WriteUInt08

SFXBinaryStreamWriter::WriteSInt16

データを SInt16 値として出力ストリームに書き込みます。

[ public ]
SFCError WriteSInt16(
    SInt16 param   // 書き込む値
);

戻り値

成功したとき : SFERR_NO_ERROR
ストリームが設定されていないとき : SFERR_INVALID_STATE
引数が不正なとき : SFERR_INVALID_PARAM
書き込めないとき : SFERR_FAILED

参照

SFXBinaryStreamWriter::WriteUInt16

SFXBinaryStreamWriter::WriteSInt32

データを SInt32 値として出力ストリームに書き込みます。

[ public ]
SFCError WriteSInt32(
    SInt32 param   // 書き込む値
);

戻り値

成功したとき : SFERR_NO_ERROR
ストリームが設定されていないとき : SFERR_INVALID_STATE
引数が不正なとき : SFERR_INVALID_PARAM
書き込めないとき : SFERR_FAILED

参照

SFXBinaryStreamWriter::WriteUInt32

SFXBinaryStreamWriter::WriteSInt64

データを SInt64 値として出力ストリームに書き込みます。

[ public ]
SFCError WriteSInt64(
    SInt64 param   // 書き込む値
);

戻り値

成功したとき : SFERR_NO_ERROR
ストリームが設定されていないとき : SFERR_INVALID_STATE
引数が不正なとき : SFERR_INVALID_PARAM
書き込めないとき : SFERR_FAILED

参照

SFXBinaryStreamWriter::WriteUInt64

SFXBinaryStreamWriter::WriteUInt08

データを UInt08 値として出力ストリームに書き込みます。

[ public ]
SFCError WriteUInt08(
    UInt08 param   // 書き込む値
);

戻り値

成功したとき : SFERR_NO_ERROR
ストリームが設定されていないとき : SFERR_INVALID_STATE
引数が不正なとき : SFERR_INVALID_PARAM
書き込めないとき : SFERR_FAILED

参照

SFXBinaryStreamWriter::WriteSInt08

SFXBinaryStreamWriter::WriteUInt16

データを UInt16 値として出力ストリームに書き込みます。

[ public ]
SFCError WriteUInt16(
    UInt16 param   // 書き込む値
);

戻り値

成功したとき : SFERR_NO_ERROR
ストリームが設定されていないとき : SFERR_INVALID_STATE
引数が不正なとき : SFERR_INVALID_PARAM
書き込めないとき : SFERR_FAILED

参照

SFXBinaryStreamWriter::WriteSInt16

SFXBinaryStreamWriter::WriteUInt32

データを UInt32 値として出力ストリームに書き込みます。

[ public ]
SFCError WriteUInt32(
    UInt32 param   // 書き込む値
);

戻り値

成功したとき : SFERR_NO_ERROR
ストリームが設定されていないとき : SFERR_INVALID_STATE
引数が不正なとき : SFERR_INVALID_PARAM
書き込めないとき : SFERR_FAILED

参照

SFXBinaryStreamWriter::WriteSInt32

SFXBinaryStreamWriter::WriteUInt64

データを UInt64 値として出力ストリームに書き込みます。

[ public ]
SFCError WriteUInt64(
    UInt64 param   // 書き込む値
);

戻り値

成功したとき : SFERR_NO_ERROR
ストリームが設定されていないとき : SFERR_INVALID_STATE
引数が不正なとき : SFERR_INVALID_PARAM
書き込めないとき : SFERR_FAILED

参照

SFXBinaryStreamWriter::WriteSInt64

SFXBinaryStreamWriter::WriteWChar

指定した長さの WChar 型文字列を出力ストリームに書き込みます。

[ public ]
SFCError WriteWChar(
    WCharConstPtr string   // WChar 型文字列
    SInt32 length = -1     // 文字列の長さ
);

引数

string: 書き込む WChar 型文字列です。
length: 書き込む文字列の長さです。-1 を指定すると '\0' までの文字列を ('\0' を含めて) 書き込みます。

戻り値

成功したとき : SFERR_NO_ERROR
ストリームが設定されていないとき : SFERR_INVALID_STATE
引数が不正なとき : SFERR_INVALID_PARAM
メモリ不足のとき : SFERR_NO_MEMORY
書き込めないとき : SFERR_FAILED

解説

指定した長さの WChar 型文字列を書き込み、最後に '\0' を書き込みます。

参照

SFXBinaryStreamWriter::WriteAChar | SFXBinaryStreamWriter::WriteSFXAnsiString | SFXBinaryStreamWriter::WriteSFXWideString

SFXBinaryStreamWriter::operator<<

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

[ public, friend ]
SFXBinaryStreamWriterRef operator<<(
    SFXBinaryStreamWriterRef left   // ストリーム
    SFXBufferConstRef right         // バッファ
);

[ public, friend ]
SFXBinaryStreamWriterRef operator<<(
    SFXBinaryStreamWriterRef left                 // ストリーム
    SFXBinaryStreamWriter::ManipulatorSPP right   // マニピュレータ
);

[ public, friend ]
SFXBinaryStreamWriterRef operator<<(
    SFXBinaryStreamWriterRef left   // ストリーム
    SInt08 right                    // 書き込む値
);

[ public, friend ]
SFXBinaryStreamWriterRef operator<<(
    SFXBinaryStreamWriterRef left   // ストリーム
    UInt08 right                    // 書き込む値
);

[ public, friend ]
SFXBinaryStreamWriterRef operator<<(
    SFXBinaryStreamWriterRef left   // ストリーム
    SInt16 right                    // 書き込む値
);

[ public, friend ]
SFXBinaryStreamWriterRef operator<<(
    SFXBinaryStreamWriterRef left   // ストリーム
    UInt16 right                    // 書き込む値
);

[ public, friend ]
SFXBinaryStreamWriterRef operator<<(
    SFXBinaryStreamWriterRef left   // ストリーム
    SInt32 right                    // 書き込む値
);

[ public, friend ]
SFXBinaryStreamWriterRef operator<<(
    SFXBinaryStreamWriterRef left   // ストリーム
    UInt32 right                    // 書き込む値
);

[ public, friend ]
SFXBinaryStreamWriterRef operator<<(
    SFXBinaryStreamWriterRef left   // ストリーム
    SInt64 right                    // 書き込む値
);

[ public, friend ]
SFXBinaryStreamWriterRef operator<<(
    SFXBinaryStreamWriterRef left   // ストリーム
    UInt64 right                    // 書き込む値
);

[ public, friend ]
SFXBinaryStreamWriterRef operator<<(
    SFXBinaryStreamWriterRef left   // ストリーム
    Float32 right                   // 書き込む値
);

[ public, friend ]
SFXBinaryStreamWriterRef operator<<(
    SFXBinaryStreamWriterRef left   // ストリーム
    Float64 right                   // 書き込む値
);

[ public, friend ]
SFXBinaryStreamWriterRef operator<<(
    SFXBinaryStreamWriterRef left   // ストリーム
    ACharConstPtr right             // 書き込む AChar 型文字列
);

[ public, friend ]
SFXBinaryStreamWriterRef operator<<(
    SFXBinaryStreamWriterRef left   // ストリーム
    WCharConstPtr right             // 書き込む WChar 型文字列
);

[ public, friend ]
SFXBinaryStreamWriterRef operator<<(
    SFXBinaryStreamWriterRef left   // ストリーム
    SFXAnsiStringConstRef right     // 書き込む SFXAnsiString 文字列
);

[ public, friend ]
SFXBinaryStreamWriterRef operator<<(
    SFXBinaryStreamWriterRef left   // ストリーム
    SFXWideStringConstRef right     // 書き込む SFXWideString 文字列
);

解説

詳細情報 : Write 関数 API リファレンス

参照