Table of Contents

Interface IDataWriter

Namespace
Windows.Storage.Streams
Assembly
Windows.Storage.Streams.dll

Provides write access to an output stream.

public interface IDataWriter
Extension Methods

Properties

ByteOrder

Gets or sets the byte order of the data in the output stream.

ByteOrder ByteOrder { get; }

Property Value

ByteOrder

One of the enumeration values.

Remarks

nanoFramework doesn't this feature. ByteOrder is always LittleEndian.

UnicodeEncoding

Gets or sets the Unicode character encoding for the output stream.

UnicodeEncoding UnicodeEncoding { get; }

Property Value

UnicodeEncoding

One of the enumeration values.

Remarks

nanoFramework doesn't this feature. UnicodeEncoding is always Utf8.

UnstoredBufferLength

Gets the size of the buffer that has not been used.

uint UnstoredBufferLength { get; }

Property Value

uint

The available buffer length, in bytes.

Methods

Flush()

Flushes data.

bool Flush()

Returns

bool

The stream flush operation.

Remarks

The Flush method ensures that the data has reached the target storage medium that the stream represents. For example, to improve application responsiveness and throughput, a file stream might respond to a write operation by copying the buffer into another temporary storage medium and returning immediately, while the target device begins writing the data concurrently. The Flush method doesn't complete until all data specified in previous write calls has reached the target storage medium. If the data can't be written, or an error occurred during a write operation, the method returns false. The Flush method may produce latencies and does not always guarantee durable and coherent storage of data.It's generally recommended to avoid this method if possible.

MeasureString(string)

Gets the size of a string.

uint MeasureString(string value)

Parameters

value string

The string.

Returns

uint

The size of the string, in bytes.

Store()

Commits data in the buffer to a backing store.

uint Store()

Returns

uint

The store data operation.

WriteBoolean(bool)

Writes a Boolean value to the output stream.

void WriteBoolean(bool value)

Parameters

value bool

The value to write.

WriteBuffer(IBuffer)

Writes a number of bytes from a buffer to the output stream.

void WriteBuffer(IBuffer buffer)

Parameters

buffer IBuffer

The value to write.

WriteBuffer(IBuffer, uint, uint)

Writes a range of bytes from a buffer to the output stream.

void WriteBuffer(IBuffer buffer, uint start, uint count)

Parameters

buffer IBuffer

The buffer.

start uint

The starting byte to be written.

count uint

The number of bytes to write.

WriteByte(byte)

Writes a byte value to the output stream.

void WriteByte(byte value)

Parameters

value byte

The value to write.

WriteBytes(byte[])

Writes an array of byte values to the output stream.

void WriteBytes(byte[] value)

Parameters

value byte[]

The value to write.

WriteDateTime(DateTime)

Writes a date and time value to the output stream.

void WriteDateTime(DateTime value)

Parameters

value DateTime

The value to write.

WriteDouble(double)

Writes a floating-point value to the output stream.

void WriteDouble(double value)

Parameters

value double

The value to write.

WriteGuid(Guid)

Writes a GUID value to the output stream.

void WriteGuid(Guid value)

Parameters

value Guid

The value to write.

WriteInt16(short)

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

void WriteInt16(short value)

Parameters

value short

The value to write.

WriteInt32(int)

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

void WriteInt32(int value)

Parameters

value int

The value to write.

WriteInt64(long)

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

void WriteInt64(long value)

Parameters

value long

The value to write.

WriteSingle(float)

Write a floating-point value to the output stream.

void WriteSingle(float value)

Parameters

value float

The value to write.

WriteString(string)

Writes a string value to the output stream.

uint WriteString(string value)

Parameters

value string

The value to write.

Returns

uint

The length of the string.

WriteTimeSpan(TimeSpan)

Writes a time interval value to the output stream.

void WriteTimeSpan(TimeSpan value)

Parameters

value TimeSpan

The value to write.

WriteUInt16(ushort)

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

void WriteUInt16(ushort value)

Parameters

value ushort

The value to write.

WriteUInt32(uint)

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

void WriteUInt32(uint value)

Parameters

value uint

The value to write.

WriteUInt64(ulong)

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

void WriteUInt64(ulong value)

Parameters

value ulong

The value to write.