Asposecpplib
System::IO::StreamWriter Class Reference

Represents a writer that writes characters to a byte stream. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

Inherits System::IO::TextWriter.

Public Member Functions

ASPOSECPP_SHARED_API StreamWriter (const SharedPtr< Stream > &stream)
 Constructs an instance of StreamWriter object that writes characters to the specified underlying stream using UTF-8 encoding and a buffer with default size of 1024 bytes. More...
 
ASPOSECPP_SHARED_API StreamWriter (const SharedPtr< Stream > &stream, const EncodingPtr &encoding)
 Constructs an instance of StreamWriter object that writes characters to the specified underlying stream using the specified encoding and a buffer with default size of 1024 bytes. More...
 
ASPOSECPP_SHARED_API StreamWriter (const SharedPtr< Stream > &stream, const EncodingPtr &encoding, int buffer_size, bool leave_open=false)
 Constructs an instance of StreamWriter object that writes characters to the specified underlying stream using the specified encoding and a buffer of the specified size. A parameter specifies whether the underlying stream should be closed when the StreamWriter object is disposed. More...
 
ASPOSECPP_SHARED_API StreamWriter (const String &path)
 Constructs an instance of StreamWriter object that writes characters to the specified file using UTF-8 encoding and a buffer with default size of 1024 bytes. More...
 
ASPOSECPP_SHARED_API StreamWriter (const String &path, bool append, const EncodingPtr &encoding=System::Text::Encoding::get_UTF8Unmarked())
 Constructs an instance of StreamWriter object that writes characters to the specified file using the specified encoding and a buffer with default size of 1024 bytes. A parameter specifies whether the data should be appened to the file or the file should be overwritten. More...
 
ASPOSECPP_SHARED_API StreamWriter (const String &path, bool append, const EncodingPtr &encoding, int buffer_size)
 Constructs an instance of StreamWriter object that writes characters to the specified file using the specified encoding and buffer size. A parameter specifies whether the data should be appened to the file or the file should be overwritten. More...
 
ASPOSECPP_SHARED_API ~StreamWriter ()
 Destructor. More...
 
ASPOSECPP_SHARED_API bool get_AutoFlush () const
 Returns a value that indicates whether the StreamWriter will flush the data to the underlying stream every time method StreamWriter::Write is called. More...
 
ASPOSECPP_SHARED_API void set_AutoFlush (bool value)
 Returns a value that specifies whether the StreamWriter should flush the data to the underlying stream every time method StreamWriter::Write is called. More...
 
ASPOSECPP_SHARED_API SharedPtr< Streamget_BaseStream () const
 Returns a shared pointer to an object that represents the underlying stream. More...
 
ASPOSECPP_SHARED_API EncodingPtr get_Encoding () override
 Returns the currently used encoding. More...
 
ASPOSECPP_SHARED_API void Write (char_t value) override
 Writes the specified character to the stream. More...
 
ASPOSECPP_SHARED_API void Write (const String &value) override
 Writes the specified string to the stream. More...
 
ASPOSECPP_SHARED_API void Write (Object::ptr obj) override
 Writes the string representation of the specified object to the stream. More...
 
ASPOSECPP_SHARED_API void Write (SharedPtr< Array< char_t >> buffer) override
 Writes all characetrs from the specified array to the stream. More...
 
ASPOSECPP_SHARED_API void Write (SharedPtr< Array< char_t >> buffer, int index, int count) override
 Writes the specified subrange of UTF-16 characters from the specified character array to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (char_t *buffer)
 Writes the specified c-string to the stream. More...
 
ASPOSECPP_SHARED_API void WriteLine () override
 Writes line terminator characters to the stream. More...
 
ASPOSECPP_SHARED_API void WriteLine (const String &value) override
 Writes the specified string followed by the line-terminating characters to the stream. More...
 
ASPOSECPP_SHARED_API void WriteLine (Object::ptr obj) override
 Writes the string representation of the specified object followed by the line-terminating characters to the stream. More...
 
ASPOSECPP_SHARED_API void WriteLine (SharedPtr< Array< char_t >> buffer) override
 Writes all characetrs from the specified array followed by the line-terminating characters to the stream. More...
 
ASPOSECPP_SHARED_API void WriteLine (SharedPtr< Array< char_t >> buffer, int index, int count) override
 Writes the specified subrange of UTF-16 characters from the specified character array followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (char_t *buffer)
 Writes the specified c-string followed by the line-terminating characters to the stream. More...
 
template<typename T >
void Write (const System::SharedPtr< T > &obj)
 Writes the string representation of the specified object to the stream. More...
 
template<typename T >
void WriteLine (const System::SharedPtr< T > &obj)
 Writes the string representation of the specified object followed by the line-terminating characters to the stream. More...
 
ASPOSECPP_SHARED_API void Close () override
 Closes the stream and releases aquired resources. More...
 
ASPOSECPP_SHARED_API void Flush () override
 Flushes the content of the buffer to the underlying stream and then flushes the underlying stream. More...
 
- Public Member Functions inherited from System::IO::TextWriter
virtual ASPOSECPP_SHARED_API const SharedPtr< IFormatProviderget_FormatProvider () const
 Returns the currently used IFormatProvider object. More...
 
virtual ASPOSECPP_SHARED_API const System::String get_NewLine () const
 Returns a line terminator string. More...
 
virtual ASPOSECPP_SHARED_API void set_NewLine (const System::String &value)
 Sets a line terminator string. More...
 
virtual ~TextWriter ()
 Destructor. More...
 
ASPOSECPP_SHARED_API String get_NewLine ()
 Returns a line terminator string. More...
 
ASPOSECPP_SHARED_API IFormatProviderPtr get_FormatProvider ()
 Returns the currently used IFormatProvider object. More...
 
virtual void Dispose () override
 Releases all resources used by the current object and closes the undelying stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (SharedPtr< Object > value)
 Writes the string representation of the specified object to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (bool value)
 Writes the string representation of the specified boolean value to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (Decimal value)
 Writes the string representation of the specified Decimal object to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (double value)
 Writes the string representation of the specified double-precision floating point value to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (int value)
 Writes the string representation of the specified 32-bit integer value to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (int64_t value)
 Writes the string representation of the specified 64-bit integer value to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (float value)
 Writes the string representation of the specified single-precision floating point value to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (uint32_t value)
 Writes the string representation of the specified unsigned 32-bit integer value to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (uint64_t value)
 Writes the string representation of the specified unsigned 64-bit integer value to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (SharedPtr< Object > value)
 Writes the string representation of the specified object followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (bool value)
 Writes the string representation of the specified boolean value followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (char_t value)
 Writes the specified character followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (Decimal value)
 Writes the string representation of the specified Decimal object followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (double value)
 Writes the string representation of the specified double-precision floating point value followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (int value)
 Writes the string representation of the specified 32-bit integer value followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (int64_t value)
 Writes the string representation of the specified 64-bit integer value followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (float value)
 Writes the string representation of the specified single-precision floating point value followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (uint32_t value)
 Writes the string representation of the specified unsigned 32-bit integer value followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (uint64_t value)
 Writes the string representation of the specified unsigned 64-bit integer value followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (const char_t *value)
 Writes the specified c-string to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (const char_t *value)
 Writes the specified c-string followed by the line-terminating characters to the stream. More...
 
virtual ASPOSECPP_SHARED_API void Write (const TypeInfo &value)
 Writes the string representation of the specified TypeInfo object to the stream. More...
 
virtual ASPOSECPP_SHARED_API void WriteLine (const TypeInfo &value)
 Writes the string representation of the specified TypeInfo object followed by the line-terminating characters to the stream. More...
 
template<class... TArgs>
void Write (const String &format, const TArgs &... args)
 Writes the specified values formatted according to the specified format to the stream. More...
 
template<class... TArgs>
void WriteLine (const String &format, const TArgs &... args)
 Writes the specified values formatted according to the specified format followed by the line-terminating characetrs to the stream. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Additional Inherited Members

- Public Types inherited from System::IO::TextWriter
typedef System::SharedPtr< TextWriterPtr
 An alias for a shared pointer to this class. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Detailed Description

Represents a writer that writes characters to a byte stream. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

◆ StreamWriter() [1/6]

ASPOSECPP_SHARED_API System::IO::StreamWriter::StreamWriter ( const SharedPtr< Stream > &  stream)

Constructs an instance of StreamWriter object that writes characters to the specified underlying stream using UTF-8 encoding and a buffer with default size of 1024 bytes.

Parameters
streamThe underlying stream to write characters to

◆ StreamWriter() [2/6]

ASPOSECPP_SHARED_API System::IO::StreamWriter::StreamWriter ( const SharedPtr< Stream > &  stream,
const EncodingPtr encoding 
)

Constructs an instance of StreamWriter object that writes characters to the specified underlying stream using the specified encoding and a buffer with default size of 1024 bytes.

Parameters
streamThe underlying stream to write characters to
encodingThe encoding to use

◆ StreamWriter() [3/6]

ASPOSECPP_SHARED_API System::IO::StreamWriter::StreamWriter ( const SharedPtr< Stream > &  stream,
const EncodingPtr encoding,
int  buffer_size,
bool  leave_open = false 
)

Constructs an instance of StreamWriter object that writes characters to the specified underlying stream using the specified encoding and a buffer of the specified size. A parameter specifies whether the underlying stream should be closed when the StreamWriter object is disposed.

Parameters
streamThe underlying stream to write characters to
encodingThe encoding to use
buffer_sizeThe minimum size of the buffer in bytes
leave_openSpecifies whether the underlying stream should be left open after the current StreamWriter object is disposed

◆ StreamWriter() [4/6]

ASPOSECPP_SHARED_API System::IO::StreamWriter::StreamWriter ( const String path)

Constructs an instance of StreamWriter object that writes characters to the specified file using UTF-8 encoding and a buffer with default size of 1024 bytes.

Parameters
pathThe path of the file to write characters to

◆ StreamWriter() [5/6]

ASPOSECPP_SHARED_API System::IO::StreamWriter::StreamWriter ( const String path,
bool  append,
const EncodingPtr encoding = System::Text::Encoding::get_UTF8Unmarked() 
)

Constructs an instance of StreamWriter object that writes characters to the specified file using the specified encoding and a buffer with default size of 1024 bytes. A parameter specifies whether the data should be appened to the file or the file should be overwritten.

Parameters
pathThe path of the file to write characters to
appendSpecifies whether the data should be appended to the specified file (true) or the file should be overwritten (false)
encodingThe encoding to use

◆ StreamWriter() [6/6]

ASPOSECPP_SHARED_API System::IO::StreamWriter::StreamWriter ( const String path,
bool  append,
const EncodingPtr encoding,
int  buffer_size 
)

Constructs an instance of StreamWriter object that writes characters to the specified file using the specified encoding and buffer size. A parameter specifies whether the data should be appened to the file or the file should be overwritten.

Parameters
pathThe path of the file to write characters to
appendSpecifies whether the data should be appended to the specified file (true) or the file should be overwritten (false)
encodingThe encoding to use
buffer_sizeThe size of buffer to use

◆ ~StreamWriter()

ASPOSECPP_SHARED_API System::IO::StreamWriter::~StreamWriter ( )

Destructor.

Member Function Documentation

◆ Close()

ASPOSECPP_SHARED_API void System::IO::StreamWriter::Close ( )
overridevirtual

Closes the stream and releases aquired resources.

Reimplemented from System::IO::TextWriter.

◆ Flush()

ASPOSECPP_SHARED_API void System::IO::StreamWriter::Flush ( )
overridevirtual

Flushes the content of the buffer to the underlying stream and then flushes the underlying stream.

Reimplemented from System::IO::TextWriter.

◆ get_AutoFlush()

ASPOSECPP_SHARED_API bool System::IO::StreamWriter::get_AutoFlush ( ) const

Returns a value that indicates whether the StreamWriter will flush the data to the underlying stream every time method StreamWriter::Write is called.

◆ get_BaseStream()

ASPOSECPP_SHARED_API SharedPtr<Stream> System::IO::StreamWriter::get_BaseStream ( ) const

Returns a shared pointer to an object that represents the underlying stream.

◆ get_Encoding()

ASPOSECPP_SHARED_API EncodingPtr System::IO::StreamWriter::get_Encoding ( )
overridevirtual

Returns the currently used encoding.

Implements System::IO::TextWriter.

◆ set_AutoFlush()

ASPOSECPP_SHARED_API void System::IO::StreamWriter::set_AutoFlush ( bool  value)

Returns a value that specifies whether the StreamWriter should flush the data to the underlying stream every time method StreamWriter::Write is called.

◆ Write() [1/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::Write ( char_t  value)
overridevirtual

Writes the specified character to the stream.

Parameters
valueThe character to write

Reimplemented from System::IO::TextWriter.

◆ Write() [2/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::Write ( const String value)
overridevirtual

Writes the specified string to the stream.

Parameters
valueThe string to write

Reimplemented from System::IO::TextWriter.

◆ Write() [3/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::Write ( Object::ptr  obj)
override

Writes the string representation of the specified object to the stream.

Parameters
objThe object to write

◆ Write() [4/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::Write ( SharedPtr< Array< char_t >>  buffer)
overridevirtual

Writes all characetrs from the specified array to the stream.

Parameters
bufferThe array containing the characters to write

Reimplemented from System::IO::TextWriter.

◆ Write() [5/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::Write ( SharedPtr< Array< char_t >>  buffer,
int  index,
int  count 
)
overridevirtual

Writes the specified subrange of UTF-16 characters from the specified character array to the stream.

Parameters
bufferThe array containing the characters to write
indexA 0-based index of the elemnet in buffer at which the subrange to write begins
countThe number of characters in the subrange to write; -1 specifies that the subrange ends where buffer array ends

Reimplemented from System::IO::TextWriter.

◆ Write() [6/7]

virtual ASPOSECPP_SHARED_API void System::IO::StreamWriter::Write ( char_t *  buffer)
virtual

Writes the specified c-string to the stream.

Parameters
bufferThe c-string to write

◆ Write() [7/7]

template<typename T >
void System::IO::StreamWriter::Write ( const System::SharedPtr< T > &  obj)
inline

Writes the string representation of the specified object to the stream.

Parameters
objThe object to write
Template Parameters
TThe type of the object

◆ WriteLine() [1/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::WriteLine ( )
overridevirtual

Writes line terminator characters to the stream.

Reimplemented from System::IO::TextWriter.

◆ WriteLine() [2/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::WriteLine ( const String value)
overridevirtual

Writes the specified string followed by the line-terminating characters to the stream.

Parameters
valueThe string to write

Reimplemented from System::IO::TextWriter.

◆ WriteLine() [3/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::WriteLine ( Object::ptr  obj)
override

Writes the string representation of the specified object followed by the line-terminating characters to the stream.

Parameters
objThe object to write

◆ WriteLine() [4/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::WriteLine ( SharedPtr< Array< char_t >>  buffer)
overridevirtual

Writes all characetrs from the specified array followed by the line-terminating characters to the stream.

Parameters
bufferThe array containing the characters to write

Reimplemented from System::IO::TextWriter.

◆ WriteLine() [5/7]

ASPOSECPP_SHARED_API void System::IO::StreamWriter::WriteLine ( SharedPtr< Array< char_t >>  buffer,
int  index,
int  count 
)
overridevirtual

Writes the specified subrange of UTF-16 characters from the specified character array followed by the line-terminating characters to the stream.

Parameters
bufferThe array containing the characters to write
indexA 0-based index of the elemnet in buffer at which the subrange to write begins
countThe number of characters in the subrange to write; -1 specifies that the subrange ends where buffer array ends

Reimplemented from System::IO::TextWriter.

◆ WriteLine() [6/7]

virtual ASPOSECPP_SHARED_API void System::IO::StreamWriter::WriteLine ( char_t *  buffer)
inlinevirtual

Writes the specified c-string followed by the line-terminating characters to the stream.

Parameters
bufferThe c-string to write

◆ WriteLine() [7/7]

template<typename T >
void System::IO::StreamWriter::WriteLine ( const System::SharedPtr< T > &  obj)
inline

Writes the string representation of the specified object followed by the line-terminating characters to the stream.

Parameters
objThe object to write
Template Parameters
TThe type of the object