Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.Compression Assembly / Xceed.Compression Namespace / ZCryptStream Class / Read Method
An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.
The zero-based byte offset in buffer at which to begin storing the data read from the current stream.
The maximum number of bytes to be read from the current stream.


In This Topic
    Read Method (ZCryptStream)
    In This Topic
    When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
    Syntax
    'Declaration
 

    Public Overrides Function Read( _
   ByVal buffer() As Byte, _
   ByVal offset As Integer, _
   ByVal count As Integer _
) As Integer
    'Usage
 

    Dim instance As ZCryptStream
Dim buffer() As Byte
Dim offset As Integer
Dim count As Integer
Dim value As Integer
 
value = instance.Read(buffer, offset, count)
    public override int Read( 
   byte[] buffer,
   int offset,
   int count
)

    Parameters

    buffer
    An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.
    offset
    The zero-based byte offset in buffer at which to begin storing the data read from the current stream.
    count
    The maximum number of bytes to be read from the current stream.

    Return Value

    The total number of bytes read into the buffer. 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.
    Exceptions
    ExceptionDescription
    System.ArgumentExceptionThe sum of offset and count is larger than the buffer length.
    System.ArgumentNullExceptionbuffer is a null reference (Nothing in Visual Basic).
    System.ArgumentOutOfRangeExceptionoffset or count is negative.
    System.IO.IOExceptionAn I/O error occurs.
    System.NotSupportedExceptionThe stream does not support reading.
    System.ObjectDisposedExceptionMethods were called after the stream was closed.
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

    ZCryptStream Class
    ZCryptStream Members
    Base Implementation in Read

    Send Feedback