SFXAnsiStringStreamReader

Class for reading the data of SFXAnsiString string from the input stream.

#include <SFXAnsiStringStreamReader.h.hpp>

class SFXAnsiStringStreamReader : public SFXStreamReader, public SFXStringStream;

SFMTYPEDEFCLASS(SFXAnsiStringStreamReader)

Inheritance diagram

Collaboration diagram

Description

The SFXAnsiStringStreamReader class is used to read the SFXAnsiString object from the input stream such as file, TCP socket, and so on.

Reference

SFXWideStringStreamReader | SFXBinaryStreamReader

Member

Constructor/Destructor
SFXAnsiStringStreamReader( `Void` ) Constructor of SFXAnsiStringStreamReader class.

Public Functions
`SFCError`	ReadSFXAnsiString( `SFXAnsiStringPtr` param ) Read data from the input stream as a SFXAnsiString string.
`SFCError`	ReadSFXWideString( `SFXWideStringPtr` param ) Read data from the input stream as a SFXAnsiString string, and convert it into SFXWideString.
`SFXAnsiStringStreamReaderRef`	operator>>( `SFXAnsiStringStreamReaderRef` left , `SFXAnsiStringRef` right ) operator>>( `SFXAnsiStringStreamReaderRef` left , `SFXWideStringRef` right ) Read data from the input stream as a SFXAnsiString string.
`Void`	Attach( `SFXInputStreamPtr` stream ) (inherits from SFXStreamReader) Delegate the control privilege of SFXInputStream object to the SFXStreamReader object.
`Void`	Cancel( `Void` ) (inherits from SFXStreamReader) Call the Cancel function for Storage class. And also unregister the callback functions.
`SFXInputStreamPtr`	Detach( `Void` ) (inherits from SFXStreamReader) Delegate the control privilege of SFXStreamReader object to the SFXInputStream object.
`Bool`	Ends( `Void` ) (inherits from SFXStreamReader) Check whether the stream ends or not.
`SFCError`	Fetch( `Void` ) (inherits from SFXStreamReader) Fetch( `CallbackSPP` spp , `VoidPtr` reference ) (inherits from SFXStreamReader) Fetch for reading data newly.
`SInt32`	FirstIndexOf( `Byte` byte , `SInt32` index = SINT32_MINIMUM ) (inherits from SFXStreamReader) FirstIndexOf( `VoidConstPtr` buffer , `UInt32` size , `SInt32` index = SINT32_MINIMUM ) (inherits from SFXStreamReader) FirstIndexOf( `SFXBufferConstRef` buffer , `SInt32` index = SINT32_MINIMUM ) (inherits from SFXStreamReader) Get the first index of SFXStreamReader object to match with the specified data, searching from the beginning.
`UInt32`	GetReadableSize( `Void` ) (inherits from SFXStreamReader) Get the size of readable data.
`SInt32`	LastIndexOf( `Byte` byte , `SInt32` index = SINT32_MAXIMUM ) (inherits from SFXStreamReader) LastIndexOf( `VoidConstPtr` buffer , `UInt32` size , `SInt32` index = SINT32_MAXIMUM ) (inherits from SFXStreamReader) LastIndexOf( `SFXBufferConstRef` buffer , `SInt32` index = SINT32_MAXIMUM ) (inherits from SFXStreamReader) Get the last index of SFXStreamReader object to match with the specified data, searching from the end.
`SFCError`	Read( `SFXBufferPtr` buffer ) (inherits from SFXStreamReader) Read( `VoidPtr` buffer , `UInt32` size ) (inherits from SFXStreamReader) Read data from the stream.
`Void`	Release( `Void` ) (inherits from SFXStreamReader) Release the stream.
`SFCError`	ResetTrigger( `Void` ) (inherits from SFXStreamReader) Reset the trigger when the callback function will be called.
`SFCError`	Seek( `UInt32` size ) (inherits from SFXStreamReader) Move the read pointer foraward.
`SFCError`	SetTrigger( `UInt32` size ) (inherits from SFXStreamReader) SetTrigger( `VoidConstPtr` buffer , `UInt32` size ) (inherits from SFXStreamReader) SetTrigger( `SFXBufferConstRef` buffer ) (inherits from SFXStreamReader) Set the trigger when the callback function will be called.
`Bool`	Triggers( `Void` ) (inherits from SFXStreamReader) Check whether the callback function is called by trigger or not.

Types
CallbackSPP (inherits from SFXStream) Constant that represents Callback function.

SFXAnsiStringStreamReader::SFXAnsiStringStreamReader

Constructor of SFXAnsiStringStreamReader class.

[ public, explicit ]
SFXAnsiStringStreamReader(Void);

SFXAnsiStringStreamReader::ReadSFXAnsiString

Read data from the input stream as a SFXAnsiString string.

[ public ]
SFCError ReadSFXAnsiString(
    SFXAnsiStringPtr param   // pointer to the resault
);

Return value

Success : SFERR_NO_ERROR
If stream is not set : SFERR_INVALID_STATE
If argument is null : SFERR_INVALID_PARAM
If insufficient memory : SFERR_NO_MEMORY
If failed : SFERR_FAILED

Description

Read data as a string until the next "\0"

If no "\0" is found until the end, read data as a string until the end.

Reference

SFXAnsiStringStreamReader::ReadSFXWideString

SFXAnsiStringStreamReader::ReadSFXWideString

Read data from the input stream as a SFXAnsiString string, and convert it into SFXWideString.

[ public ]
SFCError ReadSFXWideString(
    SFXWideStringPtr param   // pointer to the resault
);

Return value

Success : SFERR_NO_ERROR
If stream is not set : SFERR_INVALID_STATE
If argument is null : SFERR_INVALID_PARAM
If insufficient memory : SFERR_NO_MEMORY
If failed : SFERR_FAILED

Description

Read data as a string until the next "\0"

If no "\0" is found until the end, read data as a string until the end.

Reference

SFXAnsiStringStreamReader::ReadSFXAnsiString

SFXAnsiStringStreamReader::operator>>

Read data from the input stream as a SFXAnsiString string.

[ public, friend ]
SFXAnsiStringStreamReaderRef operator>>(
    SFXAnsiStringStreamReaderRef left   // stream
    SFXAnsiStringRef right              // pointer to the resault
);

[ public, friend ]
SFXAnsiStringStreamReaderRef operator>>(
    SFXAnsiStringStreamReaderRef left   // stream
    SFXWideStringRef right              // pointer to the resault
);

Description

SFXAnsiStringStreamReader::operator>> is the same as SFXAnsiStringStreamReader::ReadSFXAnsiString function or SFXAnsiStringStreamReader::ReadSFXWideString function.

Reference

SFXAnsiStringStreamReader::ReadSFXAnsiString | SFXAnsiStringStreamReader::ReadSFXWideString