Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

GZipStream::BeginRead Method (array<Byte>^, Int32, Int32, AsyncCallback^, Object^)

 

Begins an asynchronous read operation. (Consider using the Stream::ReadAsync method instead; see the Remarks section.)

Namespace:   System.IO.Compression
Assembly:  System (in System.dll)

public:
[HostProtectionAttribute(SecurityAction::LinkDemand, ExternalThreading = true)]
virtual IAsyncResult^ BeginRead(
	array<unsigned char>^ array,
	int offset,
	int count,
	AsyncCallback^ asyncCallback,
	Object^ asyncState
) override

Parameters

array
Type: array<System::Byte>^

The byte array to read the data into.

offset
Type: System::Int32

The byte offset in array at which to begin reading data from the stream.

count
Type: System::Int32

The maximum number of bytes to read.

asyncCallback
Type: System::AsyncCallback^

An optional asynchronous callback, to be called when the read operation is complete.

asyncState
Type: System::Object^

A user-provided object that distinguishes this particular asynchronous read request from other requests.

Return Value

Type: System::IAsyncResult^

An object that represents the asynchronous read operation, which could still be pending.

Exception Condition
IOException

The method tried to read asynchronously past the end of the stream, or a disk error occurred.

ArgumentException

One or more of the arguments is invalid.

ObjectDisposedException

Methods were called after the stream was closed.

NotSupportedException

The current GZipStream implementation does not support the read operation.

InvalidOperationException

A read operation cannot be performed because the stream is closed.

Starting with the .NET Framework 4.5, you can perform asynchronous read operations by using the Stream::ReadAsync method. The BeginRead method is still available in .NET Framework 4.5 to support legacy code; however, you can implement asynchronous I/O operations more easily by using the new async methods. For more information, see .

Pass the IAsyncResult return value to the EndRead method of the stream to determine how many bytes were read and to release operating system resources used for reading. You can do this either by using the same code that called BeginRead or in a callback passed to BeginRead.

The current position in the stream is updated when the asynchronous read or write is issued, not when the I/O operation completes.

Multiple simultaneous asynchronous requests render the request completion order uncertain.

Use the CanRead property to determine whether the current GZipStream object supports reading.

If a stream is closed or you pass an invalid argument, exceptions are thrown immediately from BeginRead. Errors that occur during an asynchronous read request, such as a disk failure during the I/O request, occur on the thread pool thread and throw exceptions when calling EndRead.

The following code example shows how to use the GZipStream class to compress and decompress a file.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Return to top
Show:
© 2017 Microsoft