通过

FileStream.BeginRead 方法

  • 项目

开始异步读。

**命名空间:**System.IO
**程序集:**mscorlib（在 mscorlib.dll 中）

语法

声明
Public Overrides Function BeginRead ( _
    array As Byte(), _
    offset As Integer, _
    numBytes As Integer, _
    userCallback As AsyncCallback, _
    stateObject As Object _
) As IAsyncResult
用法
Dim instance As FileStream
Dim array As Byte()
Dim offset As Integer
Dim numBytes As Integer
Dim userCallback As AsyncCallback
Dim stateObject As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginRead(array, offset, numBytes, userCallback, stateObject)

public override IAsyncResult BeginRead (
    byte[] array,
    int offset,
    int numBytes,
    AsyncCallback userCallback,
    Object stateObject
)

public:
virtual IAsyncResult^ BeginRead (
    array<unsigned char>^ array, 
    int offset, 
    int numBytes, 
    AsyncCallback^ userCallback, 
    Object^ stateObject
) override

public IAsyncResult BeginRead (
    byte[] array, 
    int offset, 
    int numBytes, 
    AsyncCallback userCallback, 
    Object stateObject
)

public override function BeginRead (
    array : byte[], 
    offset : int, 
    numBytes : int, 
    userCallback : AsyncCallback, 
    stateObject : Object
) : IAsyncResult

参数

  • array
    要读入数据的缓冲区。
  • offset
    array 中的字节偏移量，从此处开始读取。
  • numBytes
    最多读取的字节数。
  • userCallback
    异步读操作完成后调用的方法。
  • stateObject
    一个用户提供的对象，它将该特定的异步读取请求与其他请求区别开来。

返回值

引用异步读的 IAsyncResult。

异常

异常类型 条件

ArgumentException

数组长度减去 offset 小于 numBytes。

ArgumentNullException

array 为 空引用（在 Visual Basic 中为 Nothing）。

ArgumentOutOfRangeException

offset 或 numBytes 为负。

IOException

试图在文件的末尾之外进行异步读取。

备注

每次调用 BeginRead 时都必须调用 EndRead。无法结束一个读取进程就开始另一个读取可能导致死锁等不希望出现的行为。

FileStream 提供了两种不同的操作模式：同步 I/O 和异步 I/O。虽然这两种模式都可以使用，但基础操作系统资源可能只允许以其中一种模式进行访问。默认情况下，FileStream 同步打开操作系统句柄。在 Windows 中，这将降低异步方法的速度。如果使用异步方法，请使用 FileStream(String,FileMode,FileAccess,FileShare,Int32,Boolean) 构造函数。

提示

使用 CanRead 属性可确定当前实例是否支持读取。有关更多信息，请参见 CanRead。

如果流已关闭或者传递了无效的参数，将立即从 BeginRead 中引发异常。在异步读取请求过程中出现的错误（例如 IO 请求过程中磁盘出现故障）会在线程池线程上发生，并且在调用 EndRead 时变为可见。

提示

在 Windows 上，所有小于 64 KB 的 I/O 操作都将同步完成，以获得更高的性能。当缓冲区大小小于 64 KB 时，异步 I/O 可能会妨碍性能。

必须用此 IAsyncResult 调用 EndRead，以确定所读取的字节数。

多个同时进行的异步请求会使请求完成顺序不确定。

下表列出了其他典型或相关的 I/O 任务的示例。

若要执行此操作...

请参见本主题中的示例...

创建文本文件。

如何：向文件写入文本

写入文本文件。

如何：向文件写入文本

读取文本文件。

如何：从文件读取文本

向文件中追加文本。

如何：打开并追加到日志文件

File.AppendText

FileInfo.AppendText

重命名或移动文件。

File.Move

FileInfo.MoveTo

复制文件。

File.Copy

FileInfo.CopyTo

获取文件大小。

FileInfo.Length

获取文件属性。

File.GetAttributes

设置文件属性。

File.SetAttributes

确定文件是否存在。

File.Exists

读取二进制文件。

如何：对新建的数据文件进行读取和写入

写入二进制文件。

如何：对新建的数据文件进行读取和写入

创建目录。

Directory.CreateDirectory

Directory.CreateDirectory

示例

此代码示例是为 FileStream(String,FileMode,FileAccess,FileShare,Int32,Boolean) 构造函数提供的一个更大示例的一部分。

Private Shared Sub EndWriteCallback(asyncResult As IAsyncResult)
    Dim tempState As State = _
        DirectCast(asyncResult.AsyncState, State)
    Dim fStream As FileStream = tempState.FStream
    fStream.EndWrite(asyncResult)

    ' Asynchronously read back the written data.
    fStream.Position = 0
    asyncResult = fStream.BeginRead( _ 
        tempState.ReadArray, 0 , tempState.ReadArray.Length, _
        AddressOf EndReadCallback, tempState)

    ' Concurrently do other work, such as 
    ' logging the write operation.
End Sub

static void EndWriteCallback(IAsyncResult asyncResult)
{
    State tempState = (State)asyncResult.AsyncState;
    FileStream fStream = tempState.FStream;
    fStream.EndWrite(asyncResult);

    // Asynchronously read back the written data.
    fStream.Position = 0;
    asyncResult = fStream.BeginRead(
        tempState.ReadArray, 0 , tempState.ReadArray.Length, 
        new AsyncCallback(EndReadCallback), tempState);

    // Concurrently do other work, such as 
    // logging the write operation.
}

   static void EndWriteCallback( IAsyncResult^ asyncResult )
   {
      State^ tempState = dynamic_cast<State^>(asyncResult->AsyncState);
      FileStream^ fStream = tempState->FStream;
      fStream->EndWrite( asyncResult );
      
      // Asynchronously read back the written data.
      fStream->Position = 0;
      asyncResult = fStream->BeginRead( tempState->ReadArray, 0, tempState->ReadArray->Length, gcnew AsyncCallback( &FStream::EndReadCallback ), tempState );
      
      // Concurrently do other work, such as 
      // logging the write operation.
   }

};


static void EndWriteCallback(IAsyncResult asyncResult)
{
    State tempState = ((State)(asyncResult.get_AsyncState()));
    FileStream fStream = tempState.get_FStream();
    fStream.EndWrite(asyncResult);

    // Asynchronously read back the written data.
    fStream.set_Position(0);
    asyncResult = fStream.BeginRead(tempState.get_ReadArray(), 0,
        tempState.get_ReadArray().length , 
        new AsyncCallback(EndReadCallback), tempState);

    // Concurrently do other work, such as 
    // logging the write operation.
} //EndWriteCallback

平台

Windows 98、Windows 2000 SP4、Windows Millennium Edition、Windows Server 2003、Windows XP Media Center Edition、Windows XP Professional x64 Edition、Windows XP SP2、Windows XP Starter Edition

.NET Framework 并不是对每个平台的所有版本都提供支持。有关受支持版本的列表，请参见系统要求。

版本信息

.NET Framework

受以下版本支持：2.0、1.1、1.0

.NET Compact Framework

受以下版本支持：2.0、1.0

请参见

参考

FileStream 类
FileStream 成员
System.IO 命名空间

其他资源

文件和流 I/O
如何：从文件读取文本
如何：向文件写入文本
异步文件 I/O