IRandomAccessStreamReference Interface

Definition

Enables a Windows Runtime component to provide access to an encapsulated stream.

public interface class IRandomAccessStreamReference
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Guid(871248180, 7638, 20026, 128, 103, 209, 193, 98, 232, 100, 43)]
struct IRandomAccessStreamReference
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Guid(871248180, 7638, 20026, 128, 103, 209, 193, 98, 232, 100, 43)]
public interface IRandomAccessStreamReference
Public Interface IRandomAccessStreamReference
Derived
Attributes

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

Implement the IRandomAccessStreamReference interface when your Windows Runtime component exposes a random access stream to callers. For a sequential read-only stream, implement the IInputStreamReference interface.

For example, a StorageFile provides an IRandomAccessStream for the contents of a file, so it implements the IRandomAccessStreamReference interface. Usually, providing a stream requires accessing the hard disk, so stream operations are asynchronous. Components that consume file content receive an IRandomAccessStreamReference instead of a StorageFile reference, because this interface is the more minimal requirement for the input parameter.

Important

Not all sources can provide random access streams efficiently. If a component requires only sequential read access, consider implementing the IInputStreamReference interface instead of the IRandomAccessStreamReference interface.

Methods

OpenReadAsync()

Opens a stream for random access.

Applies to

See also