Export (0) Print
Expand All

WindowsRuntimeStreamExtensions Class

.NET Framework 4.5

Contains extension methods for converting between streams in the Windows Runtime and managed streams in the .NET for Windows Store apps.

System.Object
  System.IO.WindowsRuntimeStreamExtensions

Namespace:  System.IO
Assembly:  System.Runtime.WindowsRuntime (in System.Runtime.WindowsRuntime.dll)

'Declaration
<ExtensionAttribute> _
Public NotInheritable Class WindowsRuntimeStreamExtensions

The WindowsRuntimeStreamExtensions type exposes the following members.

  NameDescription
Public methodStatic memberSupported in .NET for Windows Store appsAsInputStreamConverts a managed stream in the .NET for Windows Store apps to an input stream in the Windows Runtime.
Public methodStatic memberSupported in .NET for Windows Store appsAsOutputStreamConverts a managed stream in the .NET for Windows Store apps to an output stream in the Windows Runtime.
Public methodStatic memberSupported in .NET for Windows Store appsAsStream(IRandomAccessStream)Converts a random access stream in the Windows Runtime to a managed stream in the .NET for Windows Store apps.
Public methodStatic memberSupported in .NET for Windows Store appsAsStream(IRandomAccessStream, Int32)Converts a random access stream in the Windows Runtime to a managed stream in the .NET for Windows Store apps using the specified buffer size.
Public methodStatic memberSupported in .NET for Windows Store appsAsStreamForRead(IInputStream)Converts an input stream in the Windows Runtime to a managed stream in the .NET for Windows Store apps.
Public methodStatic memberSupported in .NET for Windows Store appsAsStreamForRead(IInputStream, Int32)Converts an input stream in the Windows Runtime to a managed stream in the .NET for Windows Store apps using the specified buffer size.
Public methodStatic memberSupported in .NET for Windows Store appsAsStreamForWrite(IOutputStream)Converts an output stream in the Windows Runtime to a managed stream in the .NET for Windows Store apps.
Public methodStatic memberSupported in .NET for Windows Store appsAsStreamForWrite(IOutputStream, Int32)Converts an output stream in the Windows Runtime to a managed stream in the .NET for Windows Store apps using the specified buffer size.
Top

These extension methods are available only when you develop Windows Store apps. The methods provide convenient ways of working with streams in Windows Store apps. You do not create an instance of the WindowsRuntimeStreamExtensions class; instead, you use these methods from instances of the IInputStream and IOutputStream interfaces and the Stream class.

The WindowsRuntimeStreamExtensions class contains two methods for converting a managed Stream object to a stream in the Windows Runtime:

The WindowsRuntimeStreamExtensions class contains three overloaded methods for converting a stream in the Windows Runtime to a Stream object:

Starting with the .NET Framework 4.5.1, the WindowsRuntimeStreamExtensions class contains a method for converting a stream to a Windows Runtime RandomAccessStream:

The following example shows how to use the AsStreamForWrite and AsStreamForRead methods to convert a managed stream to and from a stream in the Windows Runtime.

Imports System.IO
Imports Windows.Storage

NotInheritable Public Class BlankPage
    Inherits Page

    Private Async Sub CreateButton_Click(sender As Object, e As RoutedEventArgs)
        Dim newFile As StorageFile = Await ApplicationData.Current.LocalFolder.CreateFileAsync("testfile.txt")
        Dim streamNewFile = Await newFile.OpenAsync(FileAccessMode.ReadWrite)

        Using outputNewFile = streamNewFile.GetOutputStreamAt(0)
            Using writer As StreamWriter = New StreamWriter(outputNewFile.AsStreamForWrite())
                Await writer.WriteLineAsync("content for new file")
                Await writer.WriteLineAsync(UserText.Text)
            End Using 
        End Using 
    End Sub 

    Private Async Sub VerifyButton_Click(sender As Object, e As RoutedEventArgs)
        Dim openedFile As StorageFile = Await ApplicationData.Current.LocalFolder.GetFileAsync("testfile.txt")
        Dim streamOpenedFile = Await openedFile.OpenAsync(FileAccessMode.Read)

        Using inputOpenedFile = streamOpenedFile.GetInputStreamAt(0)

            Using reader As StreamReader = New StreamReader(inputOpenedFile.AsStreamForRead())
                Results.Text = Await reader.ReadToEndAsync()
            End Using 
        End Using 
    End Sub 
End Class

Here's the XAML code that is associated with the previous example.

<Page
    x:Class="ExampleApplication.BlankPage"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:local="using:ExampleApplication"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    mc:Ignorable="d">

    <StackPanel Background="{StaticResource ApplicationPageBackgroundBrush}" VerticalAlignment="Center" HorizontalAlignment="Center">
        <TextBlock Text="Provide text to write to file:"></TextBlock>
        <TextBox Name="UserText" Width="400"></TextBox>
        <Button Name="CreateButton" Content="Create File" Click="CreateButton_Click"></Button>
        <Button Name="VerifyButton" Content="Verify Contents" Click="VerifyButton_Click"></Button>
        <TextBlock Name="Results"></TextBlock>
    </StackPanel>
</Page>

.NET Framework

Supported in: 4.5

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Silverlight 8.1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft