|
|
SophiaFramework UNIVERSE 5.3 |
#include <SFXAnsiStringStreamWriter.h.hpp>
class SFXAnsiStringStreamWriter : public SFXStreamWriter, public SFXStringStream;
SFMTYPEDEFCLASS(SFXAnsiStringStreamWriter)
SFXAnsiStringStreamWriter クラスは、 ストレージの文字列ストリームへデータを AChar 文字列で書き込むときに使います。
可変長バッファストリームの場合は、 内部で SFXElasticStreamWriter クラスが利用されますが、 開発者はこれについて意識する必要はありません。
SFXAnsiStringStreamReader | SFXWideStringStreamWriter | SFXBinaryStreamWriter | SFXElasticStreamWriter | SFXAnsiString | SFXWideString | 文字型 | 文字列ストリーム | ストレージ
| コンストラクタ/デストラクタ |
|---|
|
SFXAnsiStringStreamWriter( Void ) SFXAnsiStringStreamWriter クラスのコンストラクタです。
|
| パブリック関数 | |
|---|---|
| SFCError |
WriteAChar(
ACharConstPtr string
, SInt32 length = -1
) 指定した文字列をストリームに書き込みます。
|
| SFCError |
WriteNull( Void ) '\0' をストリームに書き込みます。
|
| SFCError |
WriteSFXAnsiString(
SFXAnsiStringConstRef param
) 指定した文字列をストリームに書き込みます。
|
| SFCError |
WriteSFXWideString(
SFXWideStringConstRef param
) 指定した文字列をストリームに書き込みます。
|
| SFCError |
WriteWChar(
WCharConstPtr string
, SInt32 length = -1
) 指定した文字列をストリームに書き込みます。
|
| Void |
ends(
SFXAnsiStringStreamWriterRef stream
) '\0' をストリームに書き込むマニピュレータです。
|
| SFXAnsiStringStreamWriterRef |
operator<<(
SFXAnsiStringStreamWriterRef left
, SFXAnsiStringStreamWriter::ManipulatorSPP right
) ストリームへデータを AChar 型文字列で書き込みます。
|
| SFXAnsiStringStreamWriterRef |
operator<<(
SFXAnsiStringStreamWriterRef left
, ACharConstPtr right
) ストリームへデータを AChar 型文字列で書き込みます。
|
| SFXAnsiStringStreamWriterRef |
operator<<(
SFXAnsiStringStreamWriterRef left
, WCharConstPtr right
) ストリームへデータを AChar 型文字列で書き込みます。
|
| SFXAnsiStringStreamWriterRef |
operator<<(
SFXAnsiStringStreamWriterRef left
, SFXAnsiStringConstRef right
) ストリームへデータを AChar 型文字列で書き込みます。
|
| SFXAnsiStringStreamWriterRef |
operator<<(
SFXAnsiStringStreamWriterRef left
, SFXWideStringConstRef right
) ストリームへデータを AChar 型文字列で書き込みます。
|
| Void |
Attach(
SFXOutputStreamPtr stream
)
(SFXStreamWriter から継承)
このストリームに指定されたストリームを結び付けます。
|
| Void |
Cancel( Void )
(SFXStreamWriter から継承)
ストリームへの書き込みをキャンセルします。
|
| SFXOutputStreamPtr |
Detach( Void )
(SFXStreamWriter から継承)
このストリームに結び付けられているストリームを切り離します。
|
| SFCError |
Flush( Void )
(SFXStreamWriter から継承)
ストリームのデータをストレージに書き込みます。
|
| SFCError |
Flush(
CallbackSPP spp
, VoidPtr reference
)
(SFXStreamWriter から継承)
ストリームのデータをストレージに書き込みます。
|
| UInt32 |
GetWritableSize( Void )
(SFXStreamWriter から継承)
ストリームに書き込み可能なデータサイズを取得します。[単位: バイト]
|
| Void |
Release( Void )
(SFXStreamWriter から継承)
ストリームを解放します。
|
| SFCError |
ResetTrigger( Void )
(SFXStreamWriter から継承)
トリガー(コールバック関数が呼ばれるタイミング)をリセットします。
|
| SFCError |
SetTrigger(
UInt32 size
)
(SFXStreamWriter から継承)
トリガー(コールバック関数が呼ばれるタイミング)を設定します。
|
| SFCError |
SetTrigger(
SFXBufferConstRef buffer
)
(SFXStreamWriter から継承)
トリガー(コールバック関数が呼ばれるタイミング)を設定します。
|
| SFCError |
SetTrigger(
VoidConstPtr buffer
, UInt32 size
)
(SFXStreamWriter から継承)
トリガー(コールバック関数が呼ばれるタイミング)を設定します。
|
| Bool |
Triggers( Void )
(SFXStreamWriter から継承)
トリガーによりコールバック関数が呼び出されたか判定します。
|
| SFCError |
Write(
SFXBufferConstRef buffer
)
(SFXStreamWriter から継承)
ストリームにデータを書き込みます。
|
| SFCError |
Write(
VoidConstPtr buffer
, UInt32 size
)
(SFXStreamWriter から継承)
ストリームにデータを書き込みます。
|
| 型 |
|---|
|
ManipulatorSPP SFXAnsiStringStreamWriter クラスのマニピュレータを表す型です。
|
|
CallbackSPP
(SFXStream から継承)
コールバック関数を表す型です。
|
[ public, explicit ] SFXAnsiStringStreamWriter(Void);
特に何も行いません。
[ public ] SFCError WriteAChar( ACharConstPtr string // AChar 型文字列 SInt32 length = -1 // 文字列の長さ );
AChar 型文字列です。
AChar 型文字列の長さです。-1 を指定した場合は '\0' までの長さ ('\0' は含まない) になります。
この関数は、指定した長さの AChar 文字列をストリームバッファに書き込みます。
length 引数に "-1" を指定した場合は、 string 引数に指定した '\0' までの文字列('\0' は含まない)を指定したことになります。
![[Note]](images/note.png) |
注意 |
|---|---|
|
文字列末尾の '\0' は書き込まれません。 バイナリストリームの SFXBinaryStreamWriter::WriteAChar 関数は、 文字列末尾の '\0' も書き込みます。 | |
SFXAnsiStringStreamReader::ReadSFXAnsiString | SFXAnsiStringStreamWriter::WriteSFXAnsiString | SFXAnsiStringStreamWriter::WriteWChar | SFXAnsiStringStreamWriter::WriteSFXWideString | SFXBinaryStreamWriter::WriteAChar | SFXAnsiString | 文字型
[ public ] SFCError WriteNull(Void);
この関数は、AChar 型 の '\0' (1 バイト) をストリームバッファに書き込みます。
エラー値を返すことを除けば、 SFXAnsiStringStreamWriter::ends マニピュレータと同等です。
[ public ] SFCError WriteSFXAnsiString( SFXAnsiStringConstRef param // 書き込む文字列 );
この関数は、 指定した SFXAnsiString 文字列をストリームバッファに書き込みます。
|
注意 |
|---|---|
|
文字列の末尾に '\0' は付加されません。 バイナリストリームの SFXBinaryStreamWriter::WriteSFXAnsiString 関数は、 文字列の末尾に '\0' を付加して書き込みます。 | |
SFXAnsiStringStreamReader::ReadSFXAnsiString | SFXAnsiStringStreamWriter::WriteAChar | SFXAnsiStringStreamWriter::WriteWChar | SFXAnsiStringStreamWriter::WriteSFXWideString | SFXBinaryStreamWriter::WriteSFXAnsiString | ストリームバッファ | SFXAnsiString | 文字型
[ public ] SFCError WriteSFXWideString( SFXWideStringConstRef param // 書き込む文字列 );
この関数は、指定した SFXWideString 文字列を SFXAnsiString 文字列に変換してストリームバッファに書き込みます。
|
注意 |
|---|---|
|
文字列の末尾に '\0' は付加されません。 バイナリストリームの SFXBinaryStreamWriter::WriteSFXAnsiString 関数は、 文字列の末尾に '\0' を付加して書き込みます。 | |
SFXAnsiStringStreamReader::ReadSFXWideString | SFXAnsiStringStreamWriter::WriteAChar | SFXAnsiStringStreamWriter::WriteSFXAnsiString | SFXAnsiStringStreamWriter::WriteWChar | SFXBinaryStreamWriter::WriteSFXAnsiString | ストリームバッファ | SFXAnsiString | SFXWideString | 文字型
[ public ] SFCError WriteWChar( WCharConstPtr string // WChar 型文字列 SInt32 length = -1 // 文字列の長さ );
WChar 型文字列です。
WChar 型文字列の長さです。-1 を指定した場合は '\0' までの長さ ('\0' は含まない) になります。
この関数は、指定した長さの WChar 型文字列を SFXAnsiString 文字列に変換してストリームバッファに書き込みます。
length 引数に "-1" を指定した場合は、 string 引数に指定した '\0' までの文字列('\0' は含まない)を指定したことになります。
|
注意 |
|---|---|
|
文字列末尾の '\0' は書き込まれません。 バイナリストリームの SFXBinaryStreamWriter::WriteAChar 関数は、 文字列末尾の '\0' も書き込みます。 | |
SFXAnsiStringStreamReader::ReadSFXWideString | SFXAnsiStringStreamWriter::WriteSFXWideString | SFXAnsiStringStreamWriter::WriteAChar | SFXAnsiStringStreamWriter::WriteSFXAnsiString | SFXBinaryStreamWriter::WriteAChar | SFXAnsiString | SFXWideString | 文字型
[ public, friend ] Void ends( SFXAnsiStringStreamWriterRef stream // ストリーム );
この関数は、 AChar 型 の '\0' (1 バイト) をストリームバッファに書き込むマニピュレータです
エラー値を返さないことを除けば、 SFXAnsiStringStreamWriter::WriteNull 関数と同等です。
[ public, friend ] SFXAnsiStringStreamWriterRef operator<<( SFXAnsiStringStreamWriterRef left // ストリーム SFXAnsiStringStreamWriter::ManipulatorSPP right // マニピュレータ );
[ public, friend ] SFXAnsiStringStreamWriterRef operator<<( SFXAnsiStringStreamWriterRef left // ストリーム ACharConstPtr right // 書き込む文字列 );
[ public, friend ] SFXAnsiStringStreamWriterRef operator<<( SFXAnsiStringStreamWriterRef left // ストリーム WCharConstPtr right // 書き込む文字列 );
[ public, friend ] SFXAnsiStringStreamWriterRef operator<<( SFXAnsiStringStreamWriterRef left // ストリーム SFXAnsiStringConstRef right // 書き込む文字列 );
[ public, friend ] SFXAnsiStringStreamWriterRef operator<<( SFXAnsiStringStreamWriterRef left // ストリーム SFXWideStringConstRef right // 書き込む文字列 );
このオペレータは、 ストリームバッファへオペランドのデータを WChar 型文字列で書き込むインサータ(<< 演算子)です。
下記の理由でエラーが発生した場合は、 ストリームにデータは書き込まれず、エラー値も返されず、何も起こりません。
(※)但し、下記のこのインサータの代替関数は、これらのエラー値を返します。
|
注意 |
|---|---|
|
文字列の末尾に '\0' は付加されません。 バイナリストリームの SFXBinaryStreamWriter::operator< インサータ(<< 演算子)は、 文字列の末尾に '\0' を付加して書き込みます。 | |
SFXAnsiStringStreamReader::operator>> | SFXAnsiStringStreamWriter::WriteAChar | SFXAnsiStringStreamWriter::WriteSFXAnsiString | SFXAnsiStringStreamWriter::WriteWChar | SFXAnsiStringStreamWriter::WriteSFXWideString | SFXAnsiString | SFXWideString | 文字型
typedef Void(* SFXAnsiStringStreamWriter::ManipulatorSPP)(SFXAnsiStringStreamWriterRef stream)
|
Copyright(c) 2002 - 2024 Sophia Cradle Incorporated All Rights Reserved. |
|
![[Caution]](images/caution.png)