WindowsRuntimeStreamExtensions.AsStreamForWrite メソッド

定義

オーバーロード

AsStreamForWrite(IOutputStream)

Windows ランタイムの出力ストリームを Windows 8.x ストア アプリ用 .NET のマネージド ストリームに変換します。Converts an output stream in the Windows Runtime to a managed stream in the .NET for Windows 8.x Store apps.

AsStreamForWrite(IOutputStream, Int32)

指定のバッファー サイズを利用し、Windows ランタイムの出力ストリームを Windows ストア アプリ用 .NET のマネージド ストリームに変換します。Converts an output stream in the Windows Runtime to a managed stream in the .NET for Windows Store apps using the specified buffer size.

AsStreamForWrite(IOutputStream)

重要

この API は CLS 準拠ではありません。

Windows ランタイムの出力ストリームを Windows 8.x ストア アプリ用 .NET のマネージド ストリームに変換します。Converts an output stream in the Windows Runtime to a managed stream in the .NET for Windows 8.x Store apps.

public:
[System::Runtime::CompilerServices::Extension]
 static System::IO::Stream ^ AsStreamForWrite(Windows::Storage::Streams::IOutputStream ^ windowsRuntimeStream);
[System.CLSCompliant(false)]
public static System.IO.Stream AsStreamForWrite (this Windows.Storage.Streams.IOutputStream windowsRuntimeStream);
static member AsStreamForWrite : Windows.Storage.Streams.IOutputStream -> System.IO.Stream
<Extension()>
Public Function AsStreamForWrite (windowsRuntimeStream As IOutputStream) As Stream

パラメーター

windowsRuntimeStream
IOutputStream

変換対象の Windows ランタイム オブジェクト。The Windows Runtime object to convert.

戻り値

変換されたストリーム。The converted stream.

属性

例外

windowsRuntimeStreamnull です。windowsRuntimeStream is null.

次の例は、AsStreamForWrite および AsStreamForRead メソッドを使用して、マネージストリームを Windows ランタイム内のストリームとの間で変換する方法を示しています。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.

using System;
using System.IO;
using Windows.Storage;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;

namespace ExampleApplication
{
    public sealed partial class BlankPage : Page
    {
        public BlankPage()
        {
            this.InitializeComponent();
        }

        private async void CreateButton_Click(object sender, RoutedEventArgs e)
        {
            StorageFile newFile = await ApplicationData.Current.LocalFolder.CreateFileAsync("testfile.txt");
            var streamNewFile = await newFile.OpenAsync(FileAccessMode.ReadWrite);

            using (var outputNewFile = streamNewFile.GetOutputStreamAt(0))
            {
                using (StreamWriter writer = new StreamWriter(outputNewFile.AsStreamForWrite()))
                {
                    await writer.WriteLineAsync("content for new file");
                    await writer.WriteLineAsync(UserText.Text);
                }
            }
        }

        private async void VerifyButton_Click(object sender, RoutedEventArgs e)
        {
            StorageFile openedFile = await ApplicationData.Current.LocalFolder.GetFileAsync("testfile.txt");
            var streamOpenedFile = await openedFile.OpenAsync(FileAccessMode.Read);

            using (var inputOpenedFile = streamOpenedFile.GetInputStreamAt(0))
            {
                using (StreamReader reader = new StreamReader(inputOpenedFile.AsStreamForRead()))
                {
                    Results.Text = await reader.ReadToEndAsync();
                }
            }
        }
    }
}
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

前の例に関連付けられている XAML コードを次に示します。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>

注釈

注意

Visual Basic とC#では、このメソッドを Stream型のオブジェクトのインスタンスメソッドとして呼び出すことができます。In Visual Basic and C#, you can call this method as an instance method on any object of type Stream. インスタンス メソッド構文を使用してこのメソッドを呼び出す場合は、最初のパラメーターを省略します。When you use instance method syntax to call this method, omit the first parameter. 詳細については、「拡張メソッド (Visual Basic) 」または「拡張メソッド (C#プログラミングガイド)」を参照してください。For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

ストリームを変換するときに、既定のバッファーサイズである16384バイトが使用されます。A default buffer size of 16,384 bytes is used when converting the stream. 別のバッファーサイズを指定するには、AsStreamForWrite(IOutputStream, Int32) オーバーロードを使用します。To specify a different buffer size, use the AsStreamForWrite(IOutputStream, Int32) overload.

AsStreamForWrite(IOutputStream, Int32)

重要

この API は CLS 準拠ではありません。

指定のバッファー サイズを利用し、Windows ランタイムの出力ストリームを Windows ストア アプリ用 .NET のマネージド ストリームに変換します。Converts an output stream in the Windows Runtime to a managed stream in the .NET for Windows Store apps using the specified buffer size.

public:
[System::Runtime::CompilerServices::Extension]
 static System::IO::Stream ^ AsStreamForWrite(Windows::Storage::Streams::IOutputStream ^ windowsRuntimeStream, int bufferSize);
[System.CLSCompliant(false)]
public static System.IO.Stream AsStreamForWrite (this Windows.Storage.Streams.IOutputStream windowsRuntimeStream, int bufferSize);
static member AsStreamForWrite : Windows.Storage.Streams.IOutputStream * int -> System.IO.Stream
<Extension()>
Public Function AsStreamForWrite (windowsRuntimeStream As IOutputStream, bufferSize As Integer) As Stream

パラメーター

windowsRuntimeStream
IOutputStream

変換対象の Windows ランタイム IOutputStream オブジェクト。The Windows Runtime IOutputStream object to convert.

bufferSize
Int32

バッファーのサイズ (バイト数)。The size, in bytes, of the buffer. この値を負にすることはできませんが、0 (ゼロ) に設定してバッファリングを無効にすることはできます。This value cannot be negative, but it can be 0 (zero) to disable buffering.

戻り値

変換されたストリーム。The converted stream.

属性

例外

windowsRuntimeStreamnull です。windowsRuntimeStream is null.

bufferSize は負の値です。bufferSize is negative.

注釈

注意

Visual Basic とC#では、このメソッドを Stream型のオブジェクトのインスタンスメソッドとして呼び出すことができます。In Visual Basic and C#, you can call this method as an instance method on any object of type Stream. インスタンス メソッド構文を使用してこのメソッドを呼び出す場合は、最初のパラメーターを省略します。When you use instance method syntax to call this method, omit the first parameter. 詳細については、「拡張メソッド (Visual Basic) 」または「拡張メソッド (C#プログラミングガイド)」を参照してください。For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

ストリームを変換するときに、このメソッドを使用してバッファーサイズを指定します。You use this method to specify a buffer size when converting the stream. 16384バイトの既定のバッファーサイズを使用するには、AsStreamForWrite(IOutputStream) のオーバーロードを使用します。To use the default buffer size of 16,384 bytes, use the AsStreamForWrite(IOutputStream) overload.

ほとんどの場合、バッファリングによってストリーム操作のパフォーマンスが向上します。In most situations, buffering improves the performance of stream operations. bufferSize を0に設定してバッファリングを無効にすることができますが、この操作は、状況に応じてバッファリングを無効にすることが確実な場合にのみ行ってください。You can disable buffering by setting bufferSize to zero, but you should do this only when you are sure that disabling buffering is appropriate for your situation.

適用対象