SFXAnsiStringStreamWriter

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

#include <SFXAnsiStringStreamWriter.h.hpp>

class SFXAnsiStringStreamWriter : public SFXStreamWriter, public SFXStringStream;

SFMTYPEDEFCLASS(SFXAnsiStringStreamWriter)

継承図

協調図

解説

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

参照

SFXWideStringStreamWriter | SFXBinaryStreamWriter

メンバ

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

パブリック関数
`SFCError`	WriteAChar( `ACharConstPtr` string , `SInt32` length = -1 ) 指定した長さの AChar 型文字列を SFXAnsiString 文字列として出力ストリームに書き込みます。
`SFCError`	WriteNull( `Void` ) '\0' を書き込みます。
`SFCError`	WriteSFXAnsiString( `SFXAnsiStringConstRef` param ) SFXAnsiString 文字列を出力ストリームに書き込みます。
`SFCError`	WriteSFXWideString( `SFXWideStringConstRef` param ) SFXWideString 文字列を SFXAnsiString 文字列として出力ストリームに書き込みます。
`SFCError`	WriteWChar( `WCharConstPtr` string , `SInt32` length = -1 ) 指定した長さの WChar 型文字列を SFXAnsiString 文字列として出力ストリームに書き込みます。
`Void`	ends( `SFXAnsiStringStreamWriterRef` stream ) '\0' を書き込むマニピュレータです。
`SFXAnsiStringStreamWriterRef`	operator<<( `SFXAnsiStringStreamWriterRef` left , `SFXAnsiStringStreamWriter::ManipulatorSPP` right ) operator<<( `SFXAnsiStringStreamWriterRef` left , `SFXWideStringConstRef` right ) operator<<( `SFXAnsiStringStreamWriterRef` left , `SFXAnsiStringConstRef` right ) operator<<( `SFXAnsiStringStreamWriterRef` left , `WCharConstPtr` right ) operator<<( `SFXAnsiStringStreamWriterRef` left , `ACharConstPtr` right ) データを SFXAnsiString 文字列として出力ストリームに書き込みます。
`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 から継承) 書き込んだデータをフラッシュします。
`UInt32`	GetWritableSize( `Void` ) (SFXStreamWriter から継承) 書き込み可能なデータサイズを取得します。
`Void`	Release( `Void` ) (SFXStreamWriter から継承) ストリームを解放します。
`SFCError`	ResetTrigger( `Void` ) (SFXStreamWriter から継承) コールバック関数が呼ばれるトリガーをリセットします。
`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 から継承) ストリームにデータを書き込みます。

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

SFXAnsiStringStreamWriter::SFXAnsiStringStreamWriter

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

[ public, explicit ]
SFXAnsiStringStreamWriter(Void);

SFXAnsiStringStreamWriter::WriteAChar

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

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

引数

string: AChar 型文字列です。
length: AChar 型文字列の長さです。-1 を指定した場合は '\0' までの長さ ('\0' は含めない) になります。

戻り値

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

解説

length パラメーターで指定した長さの AChar 型文字列を書き込みます。'\0' は自動的には付加されません。

参照

SFXAnsiStringStreamWriter::WriteSFXAnsiString | SFXAnsiStringStreamWriter::WriteWChar | SFXAnsiStringStreamWriter::WriteSFXWideString

SFXAnsiStringStreamWriter::WriteNull

'\0' を書き込みます。

[ public ]
SFCError WriteNull(Void);

戻り値

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

参照

SFXAnsiStringStreamWriter::ends

SFXAnsiStringStreamWriter::WriteSFXAnsiString

SFXAnsiString 文字列を出力ストリームに書き込みます。

[ public ]
SFCError WriteSFXAnsiString(
    SFXAnsiStringConstRef param   // 書き込む文字列
);

戻り値

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

解説

'\0' は自動的には付加されません。

参照

SFXAnsiStringStreamWriter::WriteAChar | SFXAnsiStringStreamWriter::WriteWChar | SFXAnsiStringStreamWriter::WriteSFXWideString

SFXAnsiStringStreamWriter::WriteSFXWideString

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

[ public ]
SFCError WriteSFXWideString(
    SFXWideStringConstRef param   // 書き込む文字列
);

戻り値

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

解説

'\0' は自動的には付加されません。

参照

SFXAnsiStringStreamWriter::WriteAChar | SFXAnsiStringStreamWriter::WriteSFXAnsiString | SFXAnsiStringStreamWriter::WriteWChar

SFXAnsiStringStreamWriter::WriteWChar

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

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

引数

string: WChar 型文字列です。
length: WChar 型文字列の長さです。-1 を指定した場合は '\0' までの長さ ('\0' は含めない) になります。

戻り値

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

解説

length パラメーターで指定した長さの WChar 型文字列を書き込みます。'\0' は自動的には付加されません。

参照

SFXAnsiStringStreamWriter::WriteSFXWideString | SFXAnsiStringStreamWriter::WriteAChar | SFXAnsiStringStreamWriter::WriteSFXAnsiString

SFXAnsiStringStreamWriter::ends

'\0' を書き込むマニピュレータです。

[ public, friend ]
Void ends(
    SFXAnsiStringStreamWriterRef stream   // ストリーム
);

解説

SFXAnsiStringStreamWriter::WriteNull 関数と同じです。

参照

SFXAnsiStringStreamWriter::WriteNull

SFXAnsiStringStreamWriter::operator<<

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

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

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

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

[ public, friend ]
SFXAnsiStringStreamWriterRef operator<<(
    SFXAnsiStringStreamWriterRef left   // ストリーム
    SFXAnsiStringConstRef right         // 文字列
);

[ public, friend ]
SFXAnsiStringStreamWriterRef operator<<(
    SFXAnsiStringStreamWriterRef left   // ストリーム
    SFXWideStringConstRef right         // 文字列
);

解説

SFXAnsiStringStreamWriter::WriteSFXAnsiString 関数、SFXAnsiStringStreamWriter::WriteSFXWideString 関数と同じです。

参照

SFXAnsiStringStreamWriter::WriteAChar | SFXAnsiStringStreamWriter::WriteSFXAnsiString | SFXAnsiStringStreamWriter::WriteWChar | SFXAnsiStringStreamWriter::WriteSFXWideString

SFXAnsiStringStreamWriter::ManipulatorSPP

SFXAnsiStringStreamWriter クラスのマニピュレータを表す型です。

typedef Void(* SFXAnsiStringStreamWriter::ManipulatorSPP)(SFXAnsiStringStreamWriterRef stream)