FileRandomAccessStream FileRandomAccessStream FileRandomAccessStream FileRandomAccessStream Class

Supports reading and writing to a file at a specified position.

Syntax

Declaration

public sealed class FileRandomAccessStreampublic sealed class FileRandomAccessStreamPublic NotInheritable Class FileRandomAccessStreampublic sealed class FileRandomAccessStream

Properties summary

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

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

Gets the byte offset of the stream.

Gets or sets the size of the random access stream.

Methods summary

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

Closes the current stream and releases system resources.

Flushes data asynchronously in a sequential stream.

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

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

Returns an asynchronous byte reader object.

Sets the position of the stream to the specified value.

Writes data asynchronously to a file.

Properties

  • CanRead
    CanRead
    CanRead
    CanRead

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

    public bool CanRead { get; }public bool CanRead { get; }Public ReadOnly Property CanRead As boolpublic bool CanRead { get; }

    Property Value

    • bool
      bool
      bool
      bool

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

  • CanWrite
    CanWrite
    CanWrite
    CanWrite

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

    public bool CanWrite { get; }public bool CanWrite { get; }Public ReadOnly Property CanWrite As boolpublic bool CanWrite { get; }

    Property Value

    • bool
      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 ulongpublic ulong Position { get; }

    Property Value

    • ulong
      ulong
      ulong
      ulong

      The number of bytes from the start of the stream.

  • 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 ulongpublic ulong Size { get; set; }

    Property 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 IRandomAccessStreampublic IRandomAccessStream CloneStream()

    Returns

  • Close()
    Close()
    Close()
    Close()

    Closes the current stream and releases system resources.

    public void Close()public void Close()Public Function Close() As voidpublic void Close()
  • FlushAsync()
    FlushAsync()
    FlushAsync()
    FlushAsync()

    Flushes data asynchronously in a sequential stream.

    public IAsyncOperation<bool> FlushAsync()public IAsyncOperation<bool> FlushAsync()Public Function FlushAsync() As IAsyncOperation( Of bool )public IAsyncOperation<bool> FlushAsync()

    Returns

    • The stream flush operation.

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

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

    public IInputStream GetInputStreamAt(UInt64 position)public IInputStream GetInputStreamAt(UInt64 position)Public Function GetInputStreamAt(position As UInt64) As IInputStreampublic IInputStream GetInputStreamAt(UInt64 position)

    Parameters

    • position
      System.UInt64
      System.UInt64
      System.UInt64
      System.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(UInt64 position)public IOutputStream GetOutputStreamAt(UInt64 position)Public Function GetOutputStreamAt(position As UInt64) As IOutputStreampublic IOutputStream GetOutputStreamAt(UInt64 position)

    Parameters

    • position
      System.UInt64
      System.UInt64
      System.UInt64
      System.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)

    Returns an asynchronous byte reader object.

    public IAsyncOperationWithProgress<IBuffer, uint> ReadAsync(IBuffer buffer, UInt32 count, InputStreamOptions options)public IAsyncOperationWithProgress<IBuffer, uint> ReadAsync(IBuffer buffer, UInt32 count, InputStreamOptions options)Public Function ReadAsync(buffer As IBuffer, count As UInt32, options As InputStreamOptions) As IAsyncOperationWithProgress( Of IBuffer, uint )public IAsyncOperationWithProgress<IBuffer, uint> ReadAsync(IBuffer buffer, UInt32 count, InputStreamOptions options)

    Parameters

    Returns

    • The asynchronous operation.

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

    Sets the position of the stream to the specified value.

    public void Seek(UInt64 position)public void Seek(UInt64 position)Public Function Seek(position As UInt64) As voidpublic void Seek(UInt64 position)

    Parameters

    • position
      System.UInt64
      System.UInt64
      System.UInt64
      System.UInt64

      The new position of the stream.

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

    Writes data asynchronously to a file.

    public IAsyncOperationWithProgress<uint, uint> WriteAsync(IBuffer buffer)public IAsyncOperationWithProgress<uint, uint> WriteAsync(IBuffer buffer)Public Function WriteAsync(buffer As IBuffer) As IAsyncOperationWithProgress( Of uint, uint )public IAsyncOperationWithProgress<uint, uint> WriteAsync(IBuffer buffer)

    Parameters

    Returns

    • The byte writer operation.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute

Details

Assembly

Windows.Storage.Streams.dll