AdsBinaryWriter Class

Derives from BinaryWriter and writes primitive and PLC data types in binary to a stream.

Inheritance Hierarchy

System.Object
  System.IO.BinaryWriter
    TwinCAT.Ads.AdsBinaryWriter
Namespace:  TwinCAT.Ads
Assembly:  TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 4.3.0.0

Syntax

C#

public class AdsBinaryWriter : BinaryWriter

VB

Public Class AdsBinaryWriter
    Inherits BinaryWriter

The AdsBinaryWriter type exposes the following members.

Constructors

 

Name

Description

AdsBinaryWriter

Initializes a new instance of the AdsBinaryWriter class based on the supplied stream.

Properties

 

Name

Description

BaseStream

Gets the underlying stream of the BinaryWriter. (Inherited from BinaryWriter.)

Methods

 

Name

Description

Close

Closes the current BinaryWriter and the underlying stream. (Inherited from BinaryWriter.)

Dispose.

Releases all resources used by the current instance of the BinaryWriter class. (Inherited from BinaryWriter.)

Dispose(Boolean)

Releases the unmanaged resources used by the BinaryWriter and optionally releases the managed resources. (Inherited from BinaryWriter.)

Equals

Determines whether the specified object is equal to the current object. (Inherited from Object.)

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)

Flush

Clears all buffers for the current writer and causes any buffered data to be written to the underlying device. (Inherited from BinaryWriter.)

GetHashCode

Serves as the default hash function. (Inherited from Object.)

GetType

Gets the Type of the current instance. (Inherited from Object.)

MemberwiseClone

Creates a shallow copy of the current Object. (Inherited from Object.)

Seek

Sets the position within the current stream. (Inherited from BinaryWriter.)

ToString

Returns a string that represents the current object. (Inherited from Object.)

Write(Boolean)

Writes a one-byte Boolean value to the current stream, with 0 representing false and 1 representing true. (Inherited from BinaryWriter.)

Write(Byte)

Writes an unsigned byte to the current stream and advances the stream position by one byte. (Inherited from BinaryWriter.)

Write(SByte)

Writes a signed byte to the current stream and advances the stream position by one byte. (Inherited from BinaryWriter.)

Write(.Byte.)

Writes a byte array to the underlying stream. (Inherited from BinaryWriter.)

Write(Char)

Writes a Unicode character to the current stream and advances the current position of the stream in accordance with the Encoding used and the specific characters being written to the stream. (Inherited from BinaryWriter.)

Write(.Char.)

Writes a character array to the current stream and advances the current position of the stream in accordance with the Encoding used and the specific characters being written to the stream. (Inherited from BinaryWriter.)

Write(Double)

Writes an eight-byte floating-point value to the current stream and advances the stream position by eight bytes. (Inherited from BinaryWriter.)

Write(Decimal)

Writes a decimal value to the current stream and advances the stream position by sixteen bytes. (Inherited from BinaryWriter.)

Write(Int16)

Writes a two-byte signed integer to the current stream and advances the stream position by two bytes. (Inherited from BinaryWriter.)

Write(UInt16)

Writes a two-byte unsigned integer to the current stream and advances the stream position by two bytes. (Inherited from BinaryWriter.)

Write(Int32)

Writes a four-byte signed integer to the current stream and advances the stream position by four bytes. (Inherited from BinaryWriter.)

Write(UInt32)

Writes a four-byte unsigned integer to the current stream and advances the stream position by four bytes. (Inherited from BinaryWriter.)

Write(Int64)

Writes an eight-byte signed integer to the current stream and advances the stream position by eight bytes. (Inherited from BinaryWriter.)

Write(UInt64)

Writes an eight-byte unsigned integer to the current stream and advances the stream position by eight bytes. (Inherited from BinaryWriter.)

Write(Single)

Writes a four-byte floating-point value to the current stream and advances the stream position by four bytes. (Inherited from BinaryWriter.)

Write(String)

Writes a length-prefixed string to this stream in the current encoding of the BinaryWriter, and advances the current position of the stream in accordance with the encoding used and the specific characters being written to the stream. (Inherited from BinaryWriter.)

Write(.Byte., Int32, Int32)

Writes a region of a byte array to the current stream. (Inherited from BinaryWriter.)

Write(.Char., Int32, Int32)

Writes a section of a character array to the current stream, and advances the current position of the stream in accordance with the Encoding used and perhaps the specific characters being written to the stream. (Inherited from BinaryWriter.)

Write7BitEncodedInt

Writes a 32-bit integer in a compressed format. (Inherited from BinaryWriter.)

WriteGuid

Writes the Guid (16 Bytes) to the current stream.

WritePlcAnsiString

Writes a string as a PLC string to the current stream.

WritePlcAnsiStringFixedLength

Writes the PLC ANSI string in a data block of the specified size.

WritePlcType(DateTime)

Writes a date as PLC date type to the current stream.

WritePlcType(TimeSpan)

Writes a time span as PLC time type to the current stream.

WritePlcUnicodeString

Writes a (unicode) string as a PLC string to the current stream.

WritePlcUnicodeStringFixedLength

Writes the PLC UNICODE string into a data block of the specified size.

Fields

 

Name

Description

OutStream

Holds the underlying stream. (Inherited from BinaryWriter.)

Remarks

The AdsBinaryWriter is fixed to use Default encoding (ANSI).

Reference

TwinCAT.Ads Namespace