FileStream.ReadAsync Yöntem
Tanım
Önemli
Bazı bilgiler ürünün ön sürümüyle ilgilidir ve sürüm öncesinde önemli değişiklikler yapılmış olabilir. Burada verilen bilgilerle ilgili olarak Microsoft açık veya zımni hiçbir garanti vermez.
Aşırı Yüklemeler
ReadAsync(Memory<Byte>, CancellationToken) |
Geçerli dosya akışından zaman uyumsuz olarak bir bayt dizisi okur ve bunları bir bellek bölgesine yazar, dosya akışı içindeki konumu okunan bayt sayısına kadar ilerler ve iptal isteklerini izler. |
ReadAsync(Byte[], Int32, Int32, CancellationToken) |
Geçerli dosya akışındaki bayt dizisini zaman uyumsuz olarak okur ve bunları belirtilen uzaklıkta başlayan bir bayt dizisine yazar, dosya akışındaki konumu okunan bayt sayısına kadar ilerler ve iptal isteklerini izler. |
ReadAsync(Memory<Byte>, CancellationToken)
- Kaynak:
- FileStream.cs
- Kaynak:
- FileStream.cs
- Kaynak:
- FileStream.cs
Geçerli dosya akışından zaman uyumsuz olarak bir bayt dizisi okur ve bunları bir bellek bölgesine yazar, dosya akışı içindeki konumu okunan bayt sayısına kadar ilerler ve iptal isteklerini izler.
public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);
override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)
Parametreler
- cancellationToken
- CancellationToken
İptal isteklerini izlemek için belirteç. None varsayılan değerdir.
Döndürülenler
Zaman uyumsuz okuma işlemini temsil eden ve toplam okunan bayt sayısını arabelleğe kaydıran görev. Sonuç değeri, kullanılabilir durumdaki bayt sayısı istenen sayıdan küçükse istenen bayt sayısından az veya akışın sonuna ulaşıldıysa 0 (sıfır) olabilir.
Özel durumlar
İptal belirteci iptal edildi. Bu özel durum, döndürülen görevde depolanır.
Örnekler
Aşağıdaki örnekte, bir dosyadan zaman uyumsuz olarak nasıl okunduğu gösterilmektedir.
using System;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.IO;
namespace WpfApplication1
{
public partial class MainWindow : Window
{
public MainWindow()
{
InitializeComponent();
}
private async void Button_Click(object sender, RoutedEventArgs e)
{
string filename = @"c:\Temp\userinputlog.txt";
byte[] result;
using (FileStream SourceStream = File.Open(filename, FileMode.Open))
{
result = new byte[SourceStream.Length];
await SourceStream.ReadAsync(result, 0, (int)SourceStream.Length);
}
UserInput.Text = System.Text.Encoding.ASCII.GetString(result);
}
}
}
open System.Text
open System.IO
let read () =
task {
let filename = @"c:\Temp\userinputlog.txt"
use sourceStream = File.Open(filename, FileMode.Open)
let length = int sourceStream.Length
let result = Array.zeroCreate length
let! _ = sourceStream.ReadAsync(result, 0, length)
return Encoding.ASCII.GetString result
}
let main =
task {
let! text = read ()
printfn $"{text}"
}
main.Wait()
Imports System.IO
Imports System.Text
Class MainWindow
Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
Dim filename As String = "c:\Temp\userinputlog.txt"
Dim result As Byte()
Using SourceStream As FileStream = File.Open(filename, FileMode.Open)
result = New Byte(SourceStream.Length - 1) {}
Await SourceStream.ReadAsync(result, 0, CType(SourceStream.Length, Integer))
End Using
UserInput.Text = System.Text.Encoding.ASCII.GetString(result)
End Sub
End Class
Açıklamalar
yöntemi, ReadAsync
ana iş parçacığını engellemeden yoğun kaynak gerektiren dosya işlemleri gerçekleştirmenizi sağlar. Bu performans değerlendirmesi, zaman alan bir akış işleminin ui iş parçacığını engellediği ve uygulamanızın çalışmıyor gibi görünmesini sağlayabildiği bir Windows 8.x Store uygulamasında veya masaüstü uygulamasında özellikle önemlidir. Zaman uyumsuz yöntemler, Visual Basic ve C# içindeki ve await
anahtar sözcükleriyle async
birlikte kullanılır.
CanRead Geçerli örneğin okumayı destekleyip desteklemediğini belirlemek için özelliğini kullanın.
İşlem tamamlanmadan önce iptal edilirse, döndürülen görev özelliğin TaskStatus.CanceledStatus değerini içerir. Dosyanın tanıtıcısı atılırsa, döndürülen görev özelliğinde Task.Exception özel durumu içerirObjectDisposedException.
Şunlara uygulanır
ReadAsync(Byte[], Int32, Int32, CancellationToken)
- Kaynak:
- FileStream.cs
- Kaynak:
- FileStream.cs
- Kaynak:
- FileStream.cs
Geçerli dosya akışındaki bayt dizisini zaman uyumsuz olarak okur ve bunları belirtilen uzaklıkta başlayan bir bayt dizisine yazar, dosya akışındaki konumu okunan bayt sayısına kadar ilerler ve iptal isteklerini izler.
public:
override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);
[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);
override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
[<System.Runtime.InteropServices.ComVisible(false)>]
override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
Public Overrides Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)
Parametreler
- buffer
- Byte[]
Verilerin yazlýlýp yazýlýldýrýlýr.
- offset
- Int32
Akıştan veri yazmaya başlayabileceğiniz bayt uzaklığı buffer
.
- count
- Int32
Okunacak bayt sayısı üst sınırı.
- cancellationToken
- CancellationToken
İptal isteklerini izlemek için belirteç.
Döndürülenler
Zaman uyumsuz okuma işlemini temsil eden ve toplam okunan bayt sayısını arabelleğe kaydıran görev. Sonuç değeri, kullanılabilir durumdaki bayt sayısı istenen sayıdan küçükse istenen bayt sayısından az veya akışın sonuna ulaşıldıysa 0 (sıfır) olabilir.
- Öznitelikler
Özel durumlar
buffer
, null
değeridir.
offset
veya count
negatiftir.
ve count
toplamı offset
arabellek uzunluğundan daha büyüktür.
Akış okumayı desteklemiyor.
Akış atıldı.
Akış şu anda önceki bir okuma işlemi tarafından kullanılıyor.
İptal belirteci iptal edildi. Bu özel durum, döndürülen görevde depolanır.
Örnekler
Aşağıdaki örnekte, bir dosyadan zaman uyumsuz olarak nasıl okunduğu gösterilmektedir.
using System;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.IO;
namespace WpfApplication1
{
public partial class MainWindow : Window
{
public MainWindow()
{
InitializeComponent();
}
private async void Button_Click(object sender, RoutedEventArgs e)
{
string filename = @"c:\Temp\userinputlog.txt";
byte[] result;
using (FileStream SourceStream = File.Open(filename, FileMode.Open))
{
result = new byte[SourceStream.Length];
await SourceStream.ReadAsync(result, 0, (int)SourceStream.Length);
}
UserInput.Text = System.Text.Encoding.ASCII.GetString(result);
}
}
}
open System.Text
open System.IO
let read () =
task {
let filename = @"c:\Temp\userinputlog.txt"
use sourceStream = File.Open(filename, FileMode.Open)
let length = int sourceStream.Length
let result = Array.zeroCreate length
let! _ = sourceStream.ReadAsync(result, 0, length)
return Encoding.ASCII.GetString result
}
let main =
task {
let! text = read ()
printfn $"{text}"
}
main.Wait()
Imports System.IO
Imports System.Text
Class MainWindow
Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
Dim filename As String = "c:\Temp\userinputlog.txt"
Dim result As Byte()
Using SourceStream As FileStream = File.Open(filename, FileMode.Open)
result = New Byte(SourceStream.Length - 1) {}
Await SourceStream.ReadAsync(result, 0, CType(SourceStream.Length, Integer))
End Using
UserInput.Text = System.Text.Encoding.ASCII.GetString(result)
End Sub
End Class
Açıklamalar
yöntemi, ReadAsync
ana iş parçacığını engellemeden yoğun kaynak gerektiren dosya işlemleri gerçekleştirmenizi sağlar. Bu performans değerlendirmesi, zaman alan bir akış işleminin ui iş parçacığını engellediği ve uygulamanızın çalışmıyor gibi görünmesini sağlayabildiği bir Windows 8.x Store uygulamasında veya masaüstü uygulamasında özellikle önemlidir. Zaman uyumsuz yöntemler, Visual Basic ve C# içindeki ve await
anahtar sözcükleriyle async
birlikte kullanılır.
CanRead Geçerli örneğin okumayı destekleyip desteklemediğini belirlemek için özelliğini kullanın.
İşlem tamamlanmadan önce iptal edilirse, döndürülen görev özelliğin TaskStatus.CanceledTask.Status değerini içerir. Dosyanın tanıtıcısı atılırsa, döndürülen görev özelliğinde Task.Exception özel durumu içerirObjectDisposedException.
Bu yöntem, görevin içinde depolar ve yöntemin zaman uyumlu karşılık geleninin atabileceği tüm kullanım dışı özel durumları döndürür. Döndürülen görevde bir özel durum depolanırsa, görev beklenirken bu özel durum oluşturulur. gibi ArgumentExceptionkullanım özel durumları yine zaman uyumlu olarak oluşturulur. Depolanan özel durumlar için tarafından oluşan Read(Byte[], Int32, Int32)özel durumlara bakın.