SFXWideStringStreamWriter

Class for writing the data of SFXWideString string onto the output stream.

#include <SFXWideStringStreamWriter.h.hpp>

class SFXWideStringStreamWriter : public SFXStreamWriter, public SFXStringStream;

SFMTYPEDEFCLASS(SFXWideStringStreamWriter)

Inheritance diagram

Collaboration diagram

Description

The SFXWideStringStreamWriter class is used to write the SFXWideString object onto the output stream such as file, TCP socket, and so on.

Reference

SFXAnsiStringStreamWriter | SFXBinaryStreamWriter

Member

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

Public Functions
`SFCError`	WriteAChar( `ACharConstPtr` string , `SInt32` length = -1 ) Write the Achar string of specified length onto the output string as a SFXWideString string.
`SFCError`	WriteSFXAnsiString( `SFXAnsiStringConstRef` param ) Write a Achar string onto the output stream as a SFXAnsiString string.
`SFCError`	WriteSFXWideString( `SFXWideStringConstRef` param ) Write the SFXWideString string onto the output stream.
`SFCError`	WriteWChar( `WCharConstPtr` string , `SInt32` length = -1 ) Write the WChar string of specified length onto the output stream as a SFXWideString string
`SFCError`	Writenull( `Void` ) Write a "\0" onto the output stream.
`Void`	ends( `SFXWideStringStreamWriterRef` stream ) Manipulator for writing "\0".
`SFXWideStringStreamWriterRef`	operator<<( `SFXWideStringStreamWriterRef` left , `SFXWideStringStreamWriter::ManipulatorSPP` right ) operator<<( `SFXWideStringStreamWriterRef` left , `SFXAnsiStringConstRef` right ) operator<<( `SFXWideStringStreamWriterRef` left , `SFXWideStringConstRef` right ) operator<<( `SFXWideStringStreamWriterRef` left , `ACharConstPtr` right ) operator<<( `SFXWideStringStreamWriterRef` left , `WCharConstPtr` right ) Write data onto the output stream as a SFXWideString string
`Void`	Attach( `SFXOutputStreamPtr` stream ) (inherits from SFXStreamWriter) Delegate the control privilege of SFXOutputStream object to the SFXStreamWriter object.
`Void`	Cancel( `Void` ) (inherits from SFXStreamWriter) Call the Cancel function for Storage class. And also unregister the callback functions.
`SFXOutputStreamPtr`	Detach( `Void` ) (inherits from SFXStreamWriter) Delegate the control privilege of SFXStreamWriter object to the SFXOutputStream object.
`SFCError`	Flush( `Void` ) (inherits from SFXStreamWriter) Flush( `CallbackSPP` spp , `VoidPtr` reference ) (inherits from SFXStreamWriter) Flush the written data.
`UInt32`	GetWritableSize( `Void` ) (inherits from SFXStreamWriter) Get the size of writable data.
`Void`	Release( `Void` ) (inherits from SFXStreamWriter) Release the stream.
`SFCError`	ResetTrigger( `Void` ) (inherits from SFXStreamWriter) Reset the trigger when the callback function will be called.
`SFCError`	SetTrigger( `UInt32` size ) (inherits from SFXStreamWriter) SetTrigger( `VoidConstPtr` buffer , `UInt32` size ) (inherits from SFXStreamWriter) SetTrigger( `SFXBufferConstRef` buffer ) (inherits from SFXStreamWriter) Set the trigger when the callback function will be called.
`Bool`	Triggers( `Void` ) (inherits from SFXStreamWriter) Check whether the callback function is called by trigger or not.
`SFCError`	Write( `SFXBufferConstRef` buffer ) (inherits from SFXStreamWriter) Write( `VoidConstPtr` buffer , `UInt32` size ) (inherits from SFXStreamWriter) Write data onto the stream.

Types
ManipulatorSPP Constant that represents the manpulator of SFXWideStringStreamWriter class.
CallbackSPP (inherits from SFXStream) Constant that represents Callback function.

SFXWideStringStreamWriter::SFXWideStringStreamWriter

Constructor of SFXWideStringStreamWriter class.

[ public, explicit ]
SFXWideStringStreamWriter(Void);

SFXWideStringStreamWriter::WriteAChar

Write the Achar string of specified length onto the output string as a SFXWideString string.

[ public ]
SFCError WriteAChar(
    ACharConstPtr string   // string of AChar type
    SInt32 length = -1     // length of string
);

Argument

string: String of AChar type.
length: string length. If specified with "-1", the length is until the "\0"( "\0" is not included ).

Return value

Success : SFERR_NO_ERROR
If stream is not set : SFERR_INVALID_STATE
If argument is invalid : SFERR_INVALID_PARAM
If failed : SFERR_FAILED

Description

Write a AChar string of speficied length, but "\0" will not be appended automatically.

Reference

SFXWideStringStreamWriter::WriteSFXAnsiString | SFXWideStringStreamWriter::WriteWChar | SFXWideStringStreamWriter::WriteSFXWideString

SFXWideStringStreamWriter::Writenull

Write a "\0" onto the output stream.

[ public ]
SFCError Writenull(Void);

Return value

Success : SFERR_NO_ERROR
If stream is not set : SFERR_INVALID_STATE
If argument is invalid : SFERR_INVALID_PARAM
If failed : SFERR_FAILED

Reference

SFXWideStringStreamWriter::ends

SFXWideStringStreamWriter::WriteSFXAnsiString

Write a Achar string onto the output stream as a SFXAnsiString string.

[ public ]
SFCError WriteSFXAnsiString(
    SFXAnsiStringConstRef param   // string to write
);

Return value

Success : SFERR_NO_ERROR
If stream is not set : SFERR_INVALID_STATE
If argument is invalid : SFERR_INVALID_PARAM
If failed : SFERR_FAILED

Description

"\0" will not be appended automatically.

Reference

SFXWideStringStreamWriter::WriteAChar | SFXWideStringStreamWriter::WriteWChar | SFXWideStringStreamWriter::WriteSFXWideString

SFXWideStringStreamWriter::WriteSFXWideString

Write the SFXWideString string onto the output stream.

[ public ]
SFCError WriteSFXWideString(
    SFXWideStringConstRef param   // string to write
);

Return value

Success : SFERR_NO_ERROR
If stream is not set : SFERR_INVALID_STATE
If argument is invalid : SFERR_INVALID_PARAM
If failed : SFERR_FAILED

Description

"\0" will not be appended automatically.

Reference

SFXWideStringStreamWriter::WriteAChar | SFXWideStringStreamWriter::WriteSFXAnsiString | SFXWideStringStreamWriter::WriteWChar

SFXWideStringStreamWriter::WriteWChar

Write the WChar string of specified length onto the output stream as a SFXWideString string

[ public ]
SFCError WriteWChar(
    WCharConstPtr string   // string of WChar type
    SInt32 length = -1     // length of string
);

Argument

string: String of WChar type.
length: string length. If specified with "-1", the length is until the "\0"( "\0" is not included ).

Return value

Success : SFERR_NO_ERROR
If stream is not set : SFERR_INVALID_STATE
If argument is invalid : SFERR_INVALID_PARAM
If failed : SFERR_FAILED

Description

If write a AChar string of speficied length, "\0" will not be appended automatically.

Reference

SFXWideStringStreamWriter::WriteSFXWideString | SFXWideStringStreamWriter::WriteAChar | SFXWideStringStreamWriter::WriteSFXAnsiString

SFXWideStringStreamWriter::ends

Manipulator for writing "\0".

[ public, friend ]
Void ends(
    SFXWideStringStreamWriterRef stream   // stream
);

Description

It is as same as SFXWideStringStreamWriter::Writenull function.

Reference

SFXWideStringStreamWriter::Writenull

SFXWideStringStreamWriter::operator<<

Write data onto the output stream as a SFXWideString string

[ public, friend ]
SFXWideStringStreamWriterRef operator<<(
    SFXWideStringStreamWriterRef left                 // stream
    SFXWideStringStreamWriter::ManipulatorSPP right   // manipulator
);

[ public, friend ]
SFXWideStringStreamWriterRef operator<<(
    SFXWideStringStreamWriterRef left   // stream
    WCharConstPtr right                 // string of WChar type
);

[ public, friend ]
SFXWideStringStreamWriterRef operator<<(
    SFXWideStringStreamWriterRef left   // stream
    ACharConstPtr right                 // string of AChar type
);

[ public, friend ]
SFXWideStringStreamWriterRef operator<<(
    SFXWideStringStreamWriterRef left   // stream
    SFXWideStringConstRef right         // string
);

[ public, friend ]
SFXWideStringStreamWriterRef operator<<(
    SFXWideStringStreamWriterRef left   // stream
    SFXAnsiStringConstRef right         // string
);

Description

SFXWideStringStreamWriter::operator<< is the same as SFXWideStringStreamWriter::WriteSFXAnsiString function or SFXWideStringStreamWriter::WriteSFXWideString function.

Reference

SFXWideStringStreamWriter::WriteAChar | SFXWideStringStreamWriter::WriteSFXAnsiString | SFXWideStringStreamWriter::WriteWChar | SFXWideStringStreamWriter::WriteSFXWideString

SFXWideStringStreamWriter::ManipulatorSPP

Constant that represents the manpulator of SFXWideStringStreamWriter class.

typedef Void(* SFXWideStringStreamWriter::ManipulatorSPP)(SFXWideStringStreamWriterRef stream)