Overlapped Class

Definition

Provides a managed representation of a Win32 OVERLAPPED structure, including methods to transfer information from an Overlapped instance to a NativeOverlapped structure.

public class Overlapped
[System.Runtime.InteropServices.ComVisible(true)]
public class Overlapped
Inheritance
Overlapped
Attributes

Remarks

The Pack and UnsafePack methods transfer information from an Overlapped object to a NativeOverlapped structure that can be passed to Windows API functions for asynchronous file I/O. The Unpack method transfers information from a NativeOverlapped structure to an instance of the Overlapped class.

Changes to the properties of an Overlapped object affect its associated NativeOverlapped structure, and vice versa.

Constructors

Overlapped()

Initializes a new, empty instance of the Overlapped class.

Overlapped(Int32, Int32, Int32, IAsyncResult)
Obsolete.
Obsolete.
Obsolete.

Initializes a new instance of the Overlapped class with the specified file position, the 32-bit integer handle to an event that is signaled when the I/O operation is complete, and an interface through which to return the results of the operation.

Overlapped(Int32, Int32, IntPtr, IAsyncResult)

Initializes a new instance of the Overlapped class with the specified file position, the handle to an event that is signaled when the I/O operation is complete, and an interface through which to return the results of the operation.

Properties

AsyncResult

Gets or sets the object that provides status information on the I/O operation.

EventHandle
Obsolete.
Obsolete.
Obsolete.

Gets or sets the 32-bit integer handle to a synchronization event that is signaled when the I/O operation is complete.

EventHandleIntPtr

Gets or sets the handle to the synchronization event that is signaled when the I/O operation is complete.

OffsetHigh

Gets or sets the high-order word of the file position at which to start the transfer. The file position is a byte offset from the start of the file.

OffsetLow

Gets or sets the low-order word of the file position at which to start the transfer. The file position is a byte offset from the start of the file.

Methods

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
Free(NativeOverlapped*)

Frees the unmanaged memory associated with a native overlapped structure allocated by the Pack method.

GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
Pack(IOCompletionCallback, Object)

Packs the current instance into a NativeOverlapped structure, specifying a delegate that is invoked when the asynchronous I/O operation is complete and a managed object that serves as a buffer.

Pack(IOCompletionCallback)
Obsolete.
Obsolete.
Obsolete.

Packs the current instance into a NativeOverlapped structure, specifying the delegate to be invoked when the asynchronous I/O operation is complete.

ToString()

Returns a string that represents the current object.

(Inherited from Object)
Unpack(NativeOverlapped*)

Unpacks the specified unmanaged NativeOverlapped structure into a managed Overlapped object.

UnsafePack(IOCompletionCallback, Object)

Packs the current instance into a NativeOverlapped structure, specifying the delegate to invoke when the asynchronous I/O operation is complete and the managed object that serves as a buffer. Does not propagate the calling stack.

UnsafePack(IOCompletionCallback)
Obsolete.
Obsolete.
Obsolete.

Packs the current instance into a NativeOverlapped structure specifying the delegate to invoke when the asynchronous I/O operation is complete. Does not propagate the calling stack.

Applies to

Product Versions
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1