UnmanagedMemoryStream.Read Метод

Определение

Перегрузки

Read(Span<Byte>)

Считывает все байты этого неуправляемого потока памяти в указанный диапазон байтов.Reads all the bytes of this unmanaged memory stream into the specified span of bytes.

Read(Byte[], Int32, Int32)

Считывает указанное число байтов в указанный массив.Reads the specified number of bytes into the specified array.

Read(Span<Byte>)

Считывает все байты этого неуправляемого потока памяти в указанный диапазон байтов.Reads all the bytes of this unmanaged memory stream into the specified span of bytes.

public:
 override int Read(Span<System::Byte> destination);
public override int Read (Span<byte> destination);
override this.Read : Span<byte> -> int
Public Overrides Function Read (destination As Span(Of Byte)) As Integer

Параметры

destination
Span<Byte>

При возврате из этого метода данный диапазон содержит все байты из неуправляемого потока памяти.When this method returns, this span contains all the bytes from the unmanaged memory stream.

Возвращаемое значение

Общее количество байтов, считанных в место назначения.The total number of bytes read into the destination.

Read(Byte[], Int32, Int32)

Считывает указанное число байтов в указанный массив.Reads the specified number of bytes into the specified array.

public:
 override int Read(cli::array <System::Byte> ^ buffer, int offset, int count);
public override int Read (byte[] buffer, int offset, int count);
override this.Read : byte[] * int * int -> int
Public Overrides Function Read (buffer As Byte(), offset As Integer, count As Integer) As Integer

Параметры

buffer
Byte[]

Когда этот метод возвращает управление, он содержит указанный массив байтов, в котором значения между offset и (offset + count - 1) заменены байтами, считанными из текущего источника.When this method returns, contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source. Этот параметр передается неинициализированным.This parameter is passed uninitialized.

offset
Int32

Смещение байтов (начиная с нуля) в buffer, с которого начинается сохранение данных, считанных из текущего потока.The zero-based byte offset in buffer at which to begin storing the data read from the current stream.

count
Int32

Максимальное количество байтов, которое должно быть считано из текущего потока.The maximum number of bytes to read from the current stream.

Возвращаемое значение

Общее количество байтов, считанных в буфер.The total number of bytes read into the buffer. Это число может быть меньше количества запрошенных байтов, если столько байтов в настоящее время недоступно, а также равняться нулю (0), если был достигнут конец потока.This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.

Исключения

Поток закрыт.The stream is closed.

Основная память не поддерживает чтение.The underlying memory does not support reading.

-или--or- Свойству CanRead задано значение false.The CanRead property is set to false.

Параметр buffer принимает значение null.The buffer parameter is set to null.

Значение параметра offset меньше нуля.The offset parameter is less than zero.

-или--or- Значение параметра count меньше нуля.The count parameter is less than zero.

Длина массива буфера без учета параметра offset меньше значения параметра count.The length of the buffer array minus the offset parameter is less than the count parameter.

Примеры

В следующем примере кода показано, как выполнять чтение из неуправляемой памяти и запись в нее с помощью класса UnmanagedMemoryStream.The following code example demonstrates how to read from and write to unmanaged memory using the UnmanagedMemoryStream class. Блок неуправляемой памяти выделяется и освобождается с помощью класса Marshal.A block of unmanaged memory is allocated and de-allocated using the Marshal class.


// Note: you must compile this sample using the unsafe flag.
// From the command line, type the following: csc sample.cs /unsafe

using System;
using System.IO;
using System.Text;
using System.Runtime.InteropServices;

unsafe class TestWriter
{
    static void Main()
    {
        // Create some data to read and write.
        byte[] message = UnicodeEncoding.Unicode.GetBytes("Here is some data.");

        // Allocate a block of unmanaged memory and return an IntPtr object.	
        IntPtr memIntPtr = Marshal.AllocHGlobal(message.Length);

        // Get a byte pointer from the IntPtr object.
        byte* memBytePtr = (byte*)memIntPtr.ToPointer();

        // Create an UnmanagedMemoryStream object using a pointer to unmanaged memory.
        UnmanagedMemoryStream writeStream = new UnmanagedMemoryStream(memBytePtr, message.Length, message.Length, FileAccess.Write);

        // Write the data.
        writeStream.Write(message, 0, message.Length);

        // Close the stream.
        writeStream.Close();

        // Create another UnmanagedMemoryStream object using a pointer to unmanaged memory.
        UnmanagedMemoryStream readStream = new UnmanagedMemoryStream(memBytePtr, message.Length, message.Length, FileAccess.Read);

        // Create a byte array to hold data from unmanaged memory.
        byte[] outMessage = new byte[message.Length];

        // Read from unmanaged memory to the byte array.
        readStream.Read(outMessage, 0, message.Length);

        // Close the stream.
        readStream.Close();

        // Display the data to the console.
        Console.WriteLine(UnicodeEncoding.Unicode.GetString(outMessage));

        // Free the block of unmanaged memory.
        Marshal.FreeHGlobal(memIntPtr);

        Console.ReadLine();
    }
}

Комментарии

Параметр offset задает смещение байта в параметре array (индекс буфера), с которого начинается чтение, а параметр count дает максимальное число байтов для чтения из этого потока.The offset parameter gives the offset of the byte in the array parameter (the buffer index) at which to begin reading, and the count parameter gives the maximum number of bytes to be read from this stream. Возвращаемое значение — фактическое число считанных байтов или нуль, если достигнут конец потока.The returned value is the actual number of bytes read, or zero if the end of the stream is reached. Если операция чтения выполнена успешно, текущее расположение потока увеличивается на число считанных байтов.If the read operation is successful, the current position of the stream is advanced by the number of bytes read. При возникновении исключения текущее расположение потока не изменяется.If an exception occurs, the current position of the stream is unchanged.

Метод Read возвращает нуль только после достижения конца потока.The Read method returns zero only after reaching the end of the stream. В противном случае Read всегда считывает по крайней мере один байт из потока перед возвратом.Otherwise, Read always reads at least one byte from the stream before returning. Если данные из потока недоступны при вызове Read, метод блокируется до тех пор, пока не будет возвращен хотя бы один байт данных.If no data is available from the stream upon a call to Read, the method will block until at least one byte of data can be returned. Реализация может возвращать меньше байтов, чем было запрошено, даже если конец потока не был достигнут.An implementation is free to return fewer bytes than requested even if the end of the stream has not been reached.

Применяется к