I​Data​Reader I​Data​Reader I​Data​Reader Interface

Definition

Provides read access to an input stream.

public : interface IDataReaderpublic interface IDataReaderPublic Interface IDataReader
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

ByteOrder ByteOrder ByteOrder

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

public : ByteOrder ByteOrder { get; set; }public ByteOrder ByteOrder { get; set; }Public ReadWrite Property ByteOrder As ByteOrder
Value
ByteOrder ByteOrder ByteOrder

One of the enumeration values.

Attributes

InputStreamOptions InputStreamOptions InputStreamOptions

Gets or sets the read options for the input stream.

public : InputStreamOptions InputStreamOptions { get; set; }public InputStreamOptions InputStreamOptions { get; set; }Public ReadWrite Property InputStreamOptions As InputStreamOptions
Value
InputStreamOptions InputStreamOptions InputStreamOptions

One of the enumeration values.

Attributes

UnconsumedBufferLength UnconsumedBufferLength UnconsumedBufferLength

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

public : unsigned short UnconsumedBufferLength { get; }public uint UnconsumedBufferLength { get; }Public ReadOnly Property UnconsumedBufferLength As uint
Value
unsigned short uint uint

The size of the buffer that has not been read, in bytes.

Attributes

UnicodeEncoding UnicodeEncoding UnicodeEncoding

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

public : UnicodeEncoding UnicodeEncoding { get; set; }public UnicodeEncoding UnicodeEncoding { get; set; }Public ReadWrite Property UnicodeEncoding As UnicodeEncoding
Value
UnicodeEncoding UnicodeEncoding UnicodeEncoding

One of the enumeration values.

Attributes

Methods

DetachBuffer() DetachBuffer() DetachBuffer()

Detaches a buffer that was previously attached to the reader.

public : IBuffer DetachBuffer()public IBuffer DetachBuffer()Public Function DetachBuffer() As IBuffer
Returns

The detached buffer.

Attributes

DetachStream() DetachStream() DetachStream()

Detaches a stream that was previously attached to the reader.

public : IInputStream DetachStream()public IInputStream DetachStream()Public Function DetachStream() As IInputStream
Returns

The detached stream.

Attributes

LoadAsync(UInt32) LoadAsync(UInt32) LoadAsync(UInt32)

Loads data from the input stream.

public : DataReaderLoadOperation LoadAsync(unsigned int count)public DataReaderLoadOperation LoadAsync(UInt32 count)Public Function LoadAsync(count As UInt32) As DataReaderLoadOperation
Parameters
count
unsigned int UInt32 UInt32

The count of bytes to load into the intermediate buffer.

Returns
Attributes

ReadBoolean() ReadBoolean() ReadBoolean()

Reads a Boolean value from the input stream.

public : PlatForm::Boolean ReadBoolean()public bool ReadBoolean()Public Function ReadBoolean() As bool
Returns
PlatForm::Boolean bool bool

The value.

Attributes

ReadBuffer(UInt32) ReadBuffer(UInt32) ReadBuffer(UInt32)

Reads a buffer from the input stream.

public : IBuffer ReadBuffer(unsigned int length)public IBuffer ReadBuffer(UInt32 length)Public Function ReadBuffer(length As UInt32) As IBuffer
Parameters
length
unsigned int UInt32 UInt32

The length of the buffer, in bytes.

Returns

The buffer.

Attributes

ReadByte() ReadByte() ReadByte()

Reads a byte value from the input stream.

public : byte ReadByte()public byte ReadByte()Public Function ReadByte() As byte
Returns
byte byte byte

The value.

Attributes

ReadBytes(Byte[]) ReadBytes(Byte[]) ReadBytes(Byte[])

Reads an array of byte values from the input stream.

public : void ReadBytes(Byte[] value)public void ReadBytes(Byte[] value)Public Function ReadBytes(value As Byte[]) As void
Parameters
value
Byte[] Byte[] Byte[]

The array of values.

Attributes

ReadDateTime() ReadDateTime() ReadDateTime()

Reads a date and time value from the input stream.

public : DateTime ReadDateTime()public DateTimeOffset ReadDateTime()Public Function ReadDateTime() As DateTimeOffset
Returns
DateTime DateTimeOffset DateTimeOffset

The value.

Attributes

ReadDouble() ReadDouble() ReadDouble()

Reads a floating-point value from the input stream.

public : double ReadDouble()public double ReadDouble()Public Function ReadDouble() As double
Returns
double double double

The value.

Attributes

ReadGuid() ReadGuid() ReadGuid()

Reads a GUID value from the input stream.

public : PlatForm::Guid ReadGuid()public Guid ReadGuid()Public Function ReadGuid() As Guid
Returns
PlatForm::Guid Guid Guid

The value.

Attributes

ReadInt16() ReadInt16() ReadInt16()

Reads a 16-bit integer value from the input stream.

public : short ReadInt16()public short ReadInt16()Public Function ReadInt16() As short
Returns
short short short

The value.

Attributes

ReadInt32() ReadInt32() ReadInt32()

Reads a 32-bit integer value from the input stream.

public : int ReadInt32()public int ReadInt32()Public Function ReadInt32() As int
Returns
int int int

The value.

Attributes

ReadInt64() ReadInt64() ReadInt64()

Reads a 64-bit integer value from the input stream.

public : long ReadInt64()public long ReadInt64()Public Function ReadInt64() As long
Returns
long long long

The value.

Attributes

ReadSingle() ReadSingle() ReadSingle()

Reads a floating-point value from the input stream.

public : float ReadSingle()public float ReadSingle()Public Function ReadSingle() As float
Returns
float float float

The value.

Attributes

ReadString(UInt32) ReadString(UInt32) ReadString(UInt32)

Reads a string value from the input stream.

public : PlatForm::String ReadString(unsigned int codeUnitCount)public string ReadString(UInt32 codeUnitCount)Public Function ReadString(codeUnitCount As UInt32) As string
Parameters
codeUnitCount
unsigned int UInt32 UInt32

The length of the string.

Returns
PlatForm::String string string

The value.

Attributes

ReadTimeSpan() ReadTimeSpan() ReadTimeSpan()

Reads a time interval from the input stream.

public : TimeSpan ReadTimeSpan()public TimeSpan ReadTimeSpan()Public Function ReadTimeSpan() As TimeSpan
Returns
TimeSpan TimeSpan TimeSpan

The value.

Attributes

ReadUInt16() ReadUInt16() ReadUInt16()

Reads a 16-bit unsigned integer from the input stream.

public : ushort ReadUInt16()public ushort ReadUInt16()Public Function ReadUInt16() As ushort
Returns
ushort ushort ushort

The value.

Attributes

ReadUInt32() ReadUInt32() ReadUInt32()

Reads a 32-bit unsigned integer from the input stream.

public : unsigned short ReadUInt32()public uint ReadUInt32()Public Function ReadUInt32() As uint
Returns
unsigned short uint uint

The value.

Attributes

ReadUInt64() ReadUInt64() ReadUInt64()

Reads a 64-bit unsigned integer from the input stream.

public : ulong ReadUInt64()public ulong ReadUInt64()Public Function ReadUInt64() As ulong
Returns
ulong ulong ulong

The value.

Attributes