System::IO::BinaryWriter Class Reference

Inherits System::IDisposable.

Public Member Functions

 BinaryWriter (StreamPtr stream, EncodingPtr encoding=System::Text::Encoding::get_UTF8Unmarked(), bool leaveopen=false)
 
 ~BinaryWriter ()
 Destructor. More...
 
StreamPtr get_BaseStream ()
 Returns the output stream. More...
 
void Flush ()
 Flushes the output stream. More...
 
void Close ()
 Closes the current BinaryWriter object and the underlying output stream. More...
 
void Dispose () override
 Releases all resources used by the current object and closes the undelying stream. More...
 
int64_t Seek (int offset, System::IO::SeekOrigin origin=System::IO::SeekOrigin::Begin)
 
virtual void Write (uint8_t value)
 
virtual void Write (const ArrayPtr< uint8_t > &buffer, int index=0, int count=-1)
 
virtual void Write (const ArrayPtr< char_t > &buffer, int index=0, int count=-1)
 
virtual void Write (bool value)
 
virtual void Write (char16_t value)
 
virtual void Write (int16_t value)
 
virtual void Write (int value)
 
virtual void Write (int64_t value)
 
virtual void Write (uint16_t value)
 
virtual void Write (uint32_t value)
 
virtual void Write (uint64_t value)
 
virtual void Write (float value)
 
virtual void Write (double value)
 
virtual void Write (Decimal value)
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 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...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual 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)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Protected Member Functions

void Dispose (bool disposing)
 

Additional Inherited Members

- 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 values of primitive types 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

◆ BinaryWriter()

System::IO::BinaryWriter::BinaryWriter ( StreamPtr  stream,
EncodingPtr  encoding = System::Text::Encoding::get_UTF8Unmarked(),
bool  leaveopen = false 
)

Constructs an instance of BinaryWriter class that writes data to the specified stream using the specified encoding.

Parameters
streamThe output stream
encodingThe encoding to use
leaveopenSpecifies whether the stream stream should be left open (true) after the current object has been disposed or not (false)

◆ ~BinaryWriter()

System::IO::BinaryWriter::~BinaryWriter ( )

Destructor.

Member Function Documentation

◆ Close()

void System::IO::BinaryWriter::Close ( )

Closes the current BinaryWriter object and the underlying output stream.

◆ Dispose() [1/2]

void System::IO::BinaryWriter::Dispose ( )
overridevirtual

Releases all resources used by the current object and closes the undelying stream.

Reimplemented from System::IDisposable.

◆ Dispose() [2/2]

void System::IO::BinaryWriter::Dispose ( bool  disposing)
protected

Releases all resources used by the current object and closes the undelying stream.

Parameters
disposingSpecifies whether the undelying stream should be closed.

◆ Flush()

void System::IO::BinaryWriter::Flush ( )

Flushes the output stream.

◆ get_BaseStream()

StreamPtr System::IO::BinaryWriter::get_BaseStream ( )

Returns the output stream.

◆ Seek()

int64_t System::IO::BinaryWriter::Seek ( int  offset,
System::IO::SeekOrigin  origin = System::IO::SeekOrigin::Begin 
)

Sets the position of the stream represented by the current object.

Parameters
offsetThe byte offset relative to a position specified by origin
originSpecifies the position from which and the direction toward which the offset is calculated
Returns
The new position of the stream

◆ Write() [1/14]

virtual void System::IO::BinaryWriter::Write ( uint8_t  value)
virtual

Writes the specified unsigned 8-bit integer value to the output stream.

Parameters
valueThe value to write

◆ Write() [2/14]

virtual void System::IO::BinaryWriter::Write ( const ArrayPtr< uint8_t > &  buffer,
int  index = 0,
int  count = -1 
)
virtual

Writes the specified subrange of bytes from the specified byte array to the output stream.

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

◆ Write() [3/14]

virtual void System::IO::BinaryWriter::Write ( const ArrayPtr< char_t > &  buffer,
int  index = 0,
int  count = -1 
)
virtual

Writes the specified subrange of UTF-16 characters from the specified character array to the output 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

◆ Write() [4/14]

virtual void System::IO::BinaryWriter::Write ( bool  value)
virtual

Writes single byte with a value of 0 if value is 'true' and 1 if value is 'false' to the output stream.

Parameters
valueThe boolean value specifying the byte value to write to the output stream

◆ Write() [5/14]

virtual void System::IO::BinaryWriter::Write ( char16_t  value)
virtual

Writes the specified 16-bit wide character value to the output stream.

Parameters
valueThe value to write

◆ Write() [6/14]

virtual void System::IO::BinaryWriter::Write ( int16_t  value)
virtual

Writes the specified 16-bit integer value to the output stream.

Parameters
valueThe value to write

◆ Write() [7/14]

virtual void System::IO::BinaryWriter::Write ( int  value)
virtual

Writes the specified 32-bit integer value to the output stream.

Parameters
valueThe value to write

◆ Write() [8/14]

virtual void System::IO::BinaryWriter::Write ( int64_t  value)
virtual

Writes the specified 64-bit integer value to the output stream.

Parameters
valueThe value to write

◆ Write() [9/14]

virtual void System::IO::BinaryWriter::Write ( uint16_t  value)
virtual

Writes the specified unsigned 16-bit integer value to the output stream.

Parameters
valueThe value to write

◆ Write() [10/14]

virtual void System::IO::BinaryWriter::Write ( uint32_t  value)
virtual

Writes the specified unsigned 32-bit integer value to the output stream.

Parameters
valueThe value to write

◆ Write() [11/14]

virtual void System::IO::BinaryWriter::Write ( uint64_t  value)
virtual

Writes the specified unsigned 64-bit integer value to the output stream.

Parameters
valueThe value to write

◆ Write() [12/14]

virtual void System::IO::BinaryWriter::Write ( float  value)
virtual

Writes the specified single-precision floating point value to the output stream.

Parameters
valueThe value to write

◆ Write() [13/14]

virtual void System::IO::BinaryWriter::Write ( double  value)
virtual

Writes the specified double-precision floating point value to the output stream.

Parameters
valueThe value to write

◆ Write() [14/14]

virtual void System::IO::BinaryWriter::Write ( Decimal  value)
virtual

Writes the byte representation of the specified Decimal value to the output stream.

Parameters
valueThe value to write