IRandomAccessStream IRandomAccessStream IRandomAccessStream IRandomAccessStream Interface

Definition

Supports random access of data in input and output streams.

public : interface IRandomAccessStream : IClosable, IInputStream, IOutputStream
public interface IRandomAccessStream : IDisposable, IInputStream, IOutputStream
Public Interface IRandomAccessStream Implements IDisposable, IInputStream, IOutputStream
// You can't instantiate an interface directly in JavaScript. You can use objects that implement the interface, however.
Inheritance
IClosableIDisposableIDisposableIDisposable
IRandomAccessStreamIRandomAccessStreamIRandomAccessStreamIRandomAccessStream
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

For more info, see Quickstart: Reading and writing a file, which shows how to read and write bytes to a file by using a RandomAccessStream. To encode an image by using a stream, see Imaging.

Properties

CanRead CanRead CanRead CanRead

Gets a value that indicates whether the stream can be read from.

public : Platform::Boolean CanRead { get; }
public bool CanRead { get; }
Public ReadOnly Property CanRead As bool
var bool = iRandomAccessStream.canRead;
Value
Platform::Boolean bool bool bool

True if the stream can be read from. Otherwise, false.

CanWrite CanWrite CanWrite CanWrite

Gets a value that indicates whether the stream can be written to.

public : Platform::Boolean CanWrite { get; }
public bool CanWrite { get; }
Public ReadOnly Property CanWrite As bool
var bool = iRandomAccessStream.canWrite;
Value
Platform::Boolean bool bool bool

True if the stream can be written to. Otherwise, false.

Position Position Position Position

Gets the byte offset of the stream.

public : ulong Position { get; }
public ulong Position { get; }
Public ReadOnly Property Position As ulong
var ulong = iRandomAccessStream.position;
Value
ulong ulong ulong ulong

The number of bytes from the start of the stream.

Remarks

The initial offset of a IRandomAccessStream is 0.

This offset is affected by both IInputStream and IOutputStream operations.

Size Size Size Size

Gets or sets the size of the random access stream.

public : ulong Size { get; set; }
public ulong Size { get; set; }
Public ReadWrite Property Size As ulong
var ulong = iRandomAccessStream.size;
iRandomAccessStream.size = ulong;
Value
ulong ulong ulong ulong

The size of the stream.

Methods

CloneStream() CloneStream() CloneStream() CloneStream()

Creates a new instance of a IRandomAccessStream over the same resource as the current stream.

public : IRandomAccessStream CloneStream()
public IRandomAccessStream CloneStream()
Public Function CloneStream() As IRandomAccessStream
var iRandomAccessStream = iRandomAccessStream.cloneStream();
Returns

The new stream. The initial, internal position of the stream is 0.

The internal position and lifetime of this new stream are independent from the position and lifetime of the cloned stream.

Close Close Close Close

Inherited from IClosable

FlushAsync FlushAsync FlushAsync FlushAsync

Inherited from IOutputStream

GetInputStreamAt(UInt64) GetInputStreamAt(UInt64) GetInputStreamAt(UInt64) GetInputStreamAt(UInt64)

Returns an input stream at a specified location in a stream.

public : IInputStream GetInputStreamAt(unsigned __int64 position)
public IInputStream GetInputStreamAt(UInt64 position)
Public Function GetInputStreamAt(position As UInt64) As IInputStream
var iInputStream = iRandomAccessStream.getInputStreamAt(position);
Parameters
position
unsigned __int64 UInt64 UInt64 UInt64

The location in the stream at which to begin.

Returns

GetOutputStreamAt(UInt64) GetOutputStreamAt(UInt64) GetOutputStreamAt(UInt64) GetOutputStreamAt(UInt64)

Returns an output stream at a specified location in a stream.

public : IOutputStream GetOutputStreamAt(unsigned __int64 position)
public IOutputStream GetOutputStreamAt(UInt64 position)
Public Function GetOutputStreamAt(position As UInt64) As IOutputStream
var iOutputStream = iRandomAccessStream.getOutputStreamAt(position);
Parameters
position
unsigned __int64 UInt64 UInt64 UInt64

The location in the output stream at which to begin.

Returns

ReadAsync(IBuffer,UInt32,InputStreamOptions) ReadAsync(IBuffer,UInt32,InputStreamOptions) ReadAsync(IBuffer,UInt32,InputStreamOptions) ReadAsync(IBuffer,UInt32,InputStreamOptions)

Inherited from IInputStream

Seek(UInt64) Seek(UInt64) Seek(UInt64) Seek(UInt64)

Sets the position of the stream to the specified value.

public : void Seek(unsigned __int64 position)
public void Seek(UInt64 position)
Public Function Seek(position As UInt64) As void
iRandomAccessStream.seek(position);
Parameters
position
unsigned __int64 UInt64 UInt64 UInt64

The new position of the stream.

Remarks

Warning

This method does not check the position to make sure the value is valid for the stream. If the position is invalid for the stream, the ReadAsync and WriteAsync methods will return an error if you call them.

WriteAsync(IBuffer) WriteAsync(IBuffer) WriteAsync(IBuffer) WriteAsync(IBuffer)

Inherited from IOutputStream

See Also