1 <?xml version="1.0" encoding="utf-8"?><span>
4 <name>System.Threading.Overlapped</name>
7 <member name="T:System.Threading.IOCompletionCallback">
8 <summary>Receives the error code, number of bytes, and overlapped value type when an I/O operation completes on the thread pool.</summary>
9 <param name="errorCode">The error code.</param>
10 <param name="numBytes">The number of bytes that are transferred.</param>
11 <param name="pOVERLAP">A <see cref="T:System.Threading.NativeOverlapped"></see> representing an unmanaged pointer to the native overlapped value type.</param>
13 <member name="T:System.Threading.NativeOverlapped">
14 <summary>Provides an explicit layout that is visible from unmanaged code and that will have the same layout as the Win32 OVERLAPPED structure with additional reserved fields at the end.</summary>
16 <member name="F:System.Threading.NativeOverlapped.EventHandle">
17 <summary>Specifies the handle to an event set to the signaled state when the operation is complete. The calling process must set this member either to zero or to a valid event handle before calling any overlapped functions.</summary>
20 <member name="F:System.Threading.NativeOverlapped.InternalHigh">
21 <summary>Specifies the length of the data transferred. Reserved for operating system use.</summary>
24 <member name="F:System.Threading.NativeOverlapped.InternalLow">
25 <summary>Specifies a system-dependent status. Reserved for operating system use.</summary>
28 <member name="F:System.Threading.NativeOverlapped.OffsetHigh">
29 <summary>Specifies the high word of the byte offset at which to start the transfer.</summary>
32 <member name="F:System.Threading.NativeOverlapped.OffsetLow">
33 <summary>Specifies a file position at which to start the transfer.</summary>
36 <member name="T:System.Threading.Overlapped">
37 <summary>Provides a managed representation of a Win32 OVERLAPPED structure, including methods to transfer information from an <see cref="T:System.Threading.Overlapped"></see> instance to a <see cref="T:System.Threading.NativeOverlapped"></see> structure.</summary>
39 <member name="M:System.Threading.Overlapped.#ctor">
40 <summary>Initializes a new, empty instance of the <see cref="T:System.Threading.Overlapped"></see> class.</summary>
42 <member name="M:System.Threading.Overlapped.#ctor(System.Int32,System.Int32,System.Int32,System.IAsyncResult)">
43 <summary>Initializes a new instance of the <see cref="T:System.Threading.Overlapped"></see> 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.</summary>
44 <param name="offsetLo">The low word of the file position at which to start the transfer.</param>
45 <param name="offsetHi">The high word of the file position at which to start the transfer.</param>
46 <param name="hEvent">The handle to an event that is signaled when the I/O operation is complete.</param>
47 <param name="ar">An object that implements the <see cref="T:System.IAsyncResult"></see> interface and provides status information on the I/O operation.</param>
49 <member name="M:System.Threading.Overlapped.#ctor(System.Int32,System.Int32,System.IntPtr,System.IAsyncResult)">
50 <summary>Initializes a new instance of the <see cref="T:System.Threading.Overlapped"></see> 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.</summary>
51 <param name="offsetLo">The low word of the file position at which to start the transfer.</param>
52 <param name="offsetHi">The high word of the file position at which to start the transfer.</param>
53 <param name="hEvent">The handle to an event that is signaled when the I/O operation is complete.</param>
54 <param name="ar">An object that implements the <see cref="T:System.IAsyncResult"></see> interface and provides status information on the I/O operation.</param>
56 <member name="P:System.Threading.Overlapped.AsyncResult">
57 <summary>Gets or sets the object that provides status information on the I/O operation.</summary>
58 <returns>An object that implements the <see cref="T:System.IAsyncResult"></see> interface.</returns>
60 <member name="P:System.Threading.Overlapped.EventHandle">
61 <summary>Gets or sets the 32-bit integer handle to a synchronization event that is signaled when the I/O operation is complete.</summary>
62 <returns>An <see cref="T:System.Int32"></see> value representing the handle of the synchronization event.</returns>
64 <member name="P:System.Threading.Overlapped.EventHandleIntPtr">
65 <summary>Gets or sets the handle to the synchronization event that is signaled when the I/O operation is complete.</summary>
66 <returns>An <see cref="T:System.IntPtr"></see> representing the handle of the event.</returns>
68 <member name="M:System.Threading.Overlapped.Free(System.Threading.NativeOverlapped*)">
69 <summary>Frees the unmanaged memory associated with a native overlapped structure allocated by the <see cref="Overload:System.Threading.Overlapped.Pack"></see> method.</summary>
70 <param name="nativeOverlappedPtr">A pointer to the <see cref="T:System.Threading.NativeOverlapped"></see> structure to be freed.</param>
71 <exception cref="T:System.ArgumentNullException"><paramref name="nativeOverlappedPtr">nativeOverlappedPtr</paramref> is null.</exception>
73 <member name="P:System.Threading.Overlapped.OffsetHigh">
74 <summary>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.</summary>
75 <returns>An <see cref="T:System.Int32"></see> value representing the high word of the file position.</returns>
77 <member name="P:System.Threading.Overlapped.OffsetLow">
78 <summary>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.</summary>
79 <returns>An <see cref="T:System.Int32"></see> value representing the low word of the file position.</returns>
81 <member name="M:System.Threading.Overlapped.Pack(System.Threading.IOCompletionCallback)">
82 <summary>Packs the current instance into a <see cref="T:System.Threading.NativeOverlapped"></see> structure, specifying the delegate to be invoked when the asynchronous I/O operation is complete.</summary>
83 <param name="iocb">An <see cref="T:System.Threading.IOCompletionCallback"></see> delegate that represents the callback method invoked when the asynchronous I/O operation completes.</param>
84 <returns>An unmanaged pointer to a <see cref="T:System.Threading.NativeOverlapped"></see> structure.</returns>
85 <exception cref="T:System.InvalidOperationException">The current <see cref="T:System.Threading.Overlapped"></see> has already been packed.</exception>
87 <member name="M:System.Threading.Overlapped.Pack(System.Threading.IOCompletionCallback,System.Object)">
88 <summary>Packs the current instance into a <see cref="T:System.Threading.NativeOverlapped"></see> structure, specifying a delegate that is invoked when the asynchronous I/O operation is complete and a managed object that serves as a buffer.</summary>
89 <param name="iocb">An <see cref="T:System.Threading.IOCompletionCallback"></see> delegate that represents the callback method invoked when the asynchronous I/O operation completes.</param>
90 <param name="userData">An object or array of objects representing the input or output buffer for the operation. Each object represents a buffer, for example an array of bytes.</param>
91 <returns>An unmanaged pointer to a <see cref="T:System.Threading.NativeOverlapped"></see> structure.</returns>
92 <exception cref="T:System.InvalidOperationException">The current <see cref="T:System.Threading.Overlapped"></see> has already been packed.</exception>
94 <member name="M:System.Threading.Overlapped.Unpack(System.Threading.NativeOverlapped*)">
95 <summary>Unpacks the specified unmanaged <see cref="T:System.Threading.NativeOverlapped"></see> structure into a managed <see cref="T:System.Threading.Overlapped"></see> object.</summary>
96 <param name="nativeOverlappedPtr">An unmanaged pointer to a <see cref="T:System.Threading.NativeOverlapped"></see> structure.</param>
97 <returns>An <see cref="T:System.Threading.Overlapped"></see> object containing the information unpacked from the native structure.</returns>
98 <exception cref="T:System.ArgumentNullException"><paramref name="nativeOverlappedPtr">nativeOverlappedPtr</paramref> is null.</exception>
100 <member name="M:System.Threading.Overlapped.UnsafePack(System.Threading.IOCompletionCallback)">
101 <summary>Packs the current instance into a <see cref="T:System.Threading.NativeOverlapped"></see> structure specifying the delegate to invoke when the asynchronous I/O operation is complete. Does not propagate the calling stack.</summary>
102 <param name="iocb">An <see cref="T:System.Threading.IOCompletionCallback"></see> delegate that represents the callback method invoked when the asynchronous I/O operation completes.</param>
103 <returns>An unmanaged pointer to a <see cref="T:System.Threading.NativeOverlapped"></see> structure.</returns>
104 <exception cref="T:System.InvalidOperationException">The current <see cref="T:System.Threading.Overlapped"></see> has already been packed.</exception>
106 <member name="M:System.Threading.Overlapped.UnsafePack(System.Threading.IOCompletionCallback,System.Object)">
107 <summary>Packs the current instance into a <see cref="T:System.Threading.NativeOverlapped"></see> 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.</summary>
108 <param name="iocb">An <see cref="T:System.Threading.IOCompletionCallback"></see> delegate that represents the callback method invoked when the asynchronous I/O operation completes.</param>
109 <param name="userData">An object or array of objects representing the input or output buffer for the operation. Each object represents a buffer, for example an array of bytes.</param>
110 <returns>An unmanaged pointer to a <see cref="T:System.Threading.NativeOverlapped"></see> structure.</returns>
111 <exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception>
112 <exception cref="T:System.InvalidOperationException">The current <see cref="T:System.Threading.Overlapped"></see> is already packed.</exception>
114 <member name="T:System.Threading.PreAllocatedOverlapped">
117 <member name="M:System.Threading.PreAllocatedOverlapped.#ctor(System.Threading.IOCompletionCallback,System.Object,System.Object)">
118 <param name="callback"></param>
119 <param name="state"></param>
120 <param name="pinData"></param>
122 <member name="M:System.Threading.PreAllocatedOverlapped.Dispose">
125 <member name="T:System.Threading.ThreadPoolBoundHandle">
128 <member name="M:System.Threading.ThreadPoolBoundHandle.AllocateNativeOverlapped(System.Threading.PreAllocatedOverlapped)">
129 <param name="preAllocated"></param>
132 <member name="M:System.Threading.ThreadPoolBoundHandle.AllocateNativeOverlapped(System.Threading.IOCompletionCallback,System.Object,System.Object)">
133 <param name="callback"></param>
134 <param name="state"></param>
135 <param name="pinData"></param>
138 <member name="M:System.Threading.ThreadPoolBoundHandle.BindHandle(System.Runtime.InteropServices.SafeHandle)">
139 <param name="handle"></param>
142 <member name="M:System.Threading.ThreadPoolBoundHandle.Dispose">
145 <member name="M:System.Threading.ThreadPoolBoundHandle.FreeNativeOverlapped(System.Threading.NativeOverlapped*)">
146 <param name="overlapped"></param>
148 <member name="M:System.Threading.ThreadPoolBoundHandle.GetNativeOverlappedState(System.Threading.NativeOverlapped*)">
149 <param name="overlapped"></param>
152 <member name="P:System.Threading.ThreadPoolBoundHandle.Handle">