1 <?xml version="1.0" encoding="utf-8"?>
4 <name>System.Threading.ThreadPool</name>
7 <member name="T:System.Threading.IThreadPoolWorkItem">
8 <summary>Represents a work item that can be executed by the <see cref="T:System.Threading.ThreadPool" />.</summary>
10 <member name="M:System.Threading.IThreadPoolWorkItem.Execute">
11 <summary>Executes the work item on the thread pool.</summary>
13 <member name="T:System.Threading.RegisteredWaitHandle">
14 <summary>Represents a handle that has been registered when calling <see cref="M:System.Threading.ThreadPool.RegisterWaitForSingleObject(System.Threading.WaitHandle,System.Threading.WaitOrTimerCallback,System.Object,System.UInt32,System.Boolean)" />. This class cannot be inherited.</summary>
16 <member name="M:System.Threading.RegisteredWaitHandle.Unregister(System.Threading.WaitHandle)">
17 <summary>Cancels a registered wait operation issued by the <see cref="M:System.Threading.ThreadPool.RegisterWaitForSingleObject(System.Threading.WaitHandle,System.Threading.WaitOrTimerCallback,System.Object,System.UInt32,System.Boolean)" /> method.</summary>
18 <param name="waitObject">The <see cref="T:System.Threading.WaitHandle" /> to be signaled.</param>
20 <see langword="true" /> if the function succeeds; otherwise, <see langword="false" />.</returns>
22 <member name="T:System.Threading.ThreadPool">
23 <summary>Provides a pool of threads that can be used to execute tasks, post work items, process asynchronous I/O, wait on behalf of other threads, and process timers.</summary>
25 <member name="M:System.Threading.ThreadPool.BindHandle(System.IntPtr)">
26 <summary>Binds an operating system handle to the <see cref="T:System.Threading.ThreadPool" />.</summary>
27 <param name="osHandle">An <see cref="T:System.IntPtr" /> that holds the handle. The handle must have been opened for overlapped I/O on the unmanaged side.</param>
29 <see langword="true" /> if the handle is bound; otherwise, <see langword="false" />.</returns>
30 <exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception>
32 <member name="M:System.Threading.ThreadPool.BindHandle(System.Runtime.InteropServices.SafeHandle)">
33 <summary>Binds an operating system handle to the <see cref="T:System.Threading.ThreadPool" />.</summary>
34 <param name="osHandle">A <see cref="T:System.Runtime.InteropServices.SafeHandle" /> that holds the operating system handle. The handle must have been opened for overlapped I/O on the unmanaged side.</param>
36 <see langword="true" /> if the handle is bound; otherwise, <see langword="false" />.</returns>
37 <exception cref="T:System.ArgumentNullException">
38 <paramref name="osHandle" /> is <see langword="null" />.</exception>
40 <member name="P:System.Threading.ThreadPool.CompletedWorkItemCount">
41 <summary>Gets the number of work items that have been processed so far.</summary>
42 <returns>The number of work items that have been processed so far.</returns>
44 <member name="M:System.Threading.ThreadPool.GetAvailableThreads(System.Int32@,System.Int32@)">
45 <summary>Retrieves the difference between the maximum number of thread pool threads returned by the <see cref="M:System.Threading.ThreadPool.GetMaxThreads(System.Int32@,System.Int32@)" /> method, and the number currently active.</summary>
46 <param name="workerThreads">The number of available worker threads.</param>
47 <param name="completionPortThreads">The number of available asynchronous I/O threads.</param>
49 <member name="M:System.Threading.ThreadPool.GetMaxThreads(System.Int32@,System.Int32@)">
50 <summary>Retrieves the number of requests to the thread pool that can be active concurrently. All requests above that number remain queued until thread pool threads become available.</summary>
51 <param name="workerThreads">The maximum number of worker threads in the thread pool.</param>
52 <param name="completionPortThreads">The maximum number of asynchronous I/O threads in the thread pool.</param>
54 <member name="M:System.Threading.ThreadPool.GetMinThreads(System.Int32@,System.Int32@)">
55 <summary>Retrieves the minimum number of threads the thread pool creates on demand, as new requests are made, before switching to an algorithm for managing thread creation and destruction.</summary>
56 <param name="workerThreads">When this method returns, contains the minimum number of worker threads that the thread pool creates on demand.</param>
57 <param name="completionPortThreads">When this method returns, contains the minimum number of asynchronous I/O threads that the thread pool creates on demand.</param>
59 <member name="P:System.Threading.ThreadPool.PendingWorkItemCount">
60 <summary>Gets the number of work items that are currently queued to be processed.</summary>
61 <returns>The number of work items that are currently queued to be processed.</returns>
63 <member name="M:System.Threading.ThreadPool.QueueUserWorkItem(System.Threading.WaitCallback)">
64 <summary>Queues a method for execution. The method executes when a thread pool thread becomes available.</summary>
65 <param name="callBack">A <see cref="T:System.Threading.WaitCallback" /> that represents the method to be executed.</param>
67 <see langword="true" /> if the method is successfully queued; <see cref="T:System.NotSupportedException" /> is thrown if the work item could not be queued.</returns>
68 <exception cref="T:System.ArgumentNullException">
69 <paramref name="callBack" /> is <see langword="null" />.</exception>
70 <exception cref="T:System.NotSupportedException">The common language runtime (CLR) is hosted, and the host does not support this action.</exception>
72 <member name="M:System.Threading.ThreadPool.QueueUserWorkItem(System.Threading.WaitCallback,System.Object)">
73 <summary>Queues a method for execution, and specifies an object containing data to be used by the method. The method executes when a thread pool thread becomes available.</summary>
74 <param name="callBack">A <see cref="T:System.Threading.WaitCallback" /> representing the method to execute.</param>
75 <param name="state">An object containing data to be used by the method.</param>
77 <see langword="true" /> if the method is successfully queued; <see cref="T:System.NotSupportedException" /> is thrown if the work item could not be queued.</returns>
78 <exception cref="T:System.NotSupportedException">The common language runtime (CLR) is hosted, and the host does not support this action.</exception>
79 <exception cref="T:System.ArgumentNullException">
80 <paramref name="callBack" /> is <see langword="null" />.</exception>
82 <member name="M:System.Threading.ThreadPool.QueueUserWorkItem``1(System.Action{``0},``0,System.Boolean)">
83 <summary>Queues a method specified by an <see cref="T:System.Action`1" /> delegate for execution, and provides data to be used by the method. The method executes when a thread pool thread becomes available.</summary>
84 <param name="callBack">An <see cref="T:System.Action`1" /> representing the method to execute.</param>
85 <param name="state">An object containing data to be used by the method.</param>
86 <param name="preferLocal">
87 <see langword="true" /> to prefer queueing the work item in a queue close to the current thread; <see langword="false" /> to prefer queueing the work item to the thread pool's shared queue.</param>
88 <typeparam name="TState">The type of elements of <paramref name="state" />.</typeparam>
90 <see langword="true" /> if the method is successfully queued; <see cref="T:System.NotSupportedException" /> is thrown if the work item could not be queued.</returns>
92 <member name="M:System.Threading.ThreadPool.RegisterWaitForSingleObject(System.Threading.WaitHandle,System.Threading.WaitOrTimerCallback,System.Object,System.Int32,System.Boolean)">
93 <summary>Registers a delegate to wait for a <see cref="T:System.Threading.WaitHandle" />, specifying a 32-bit signed integer for the time-out in milliseconds.</summary>
94 <param name="waitObject">The <see cref="T:System.Threading.WaitHandle" /> to register. Use a <see cref="T:System.Threading.WaitHandle" /> other than <see cref="T:System.Threading.Mutex" />.</param>
95 <param name="callBack">The <see cref="T:System.Threading.WaitOrTimerCallback" /> delegate to call when the <paramref name="waitObject" /> parameter is signaled.</param>
96 <param name="state">The object that is passed to the delegate.</param>
97 <param name="millisecondsTimeOutInterval">The time-out in milliseconds. If the <paramref name="millisecondsTimeOutInterval" /> parameter is 0 (zero), the function tests the object's state and returns immediately. If <paramref name="millisecondsTimeOutInterval" /> is -1, the function's time-out interval never elapses.</param>
98 <param name="executeOnlyOnce">
99 <see langword="true" /> to indicate that the thread will no longer wait on the <paramref name="waitObject" /> parameter after the delegate has been called; <see langword="false" /> to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.</param>
100 <returns>The <see cref="T:System.Threading.RegisteredWaitHandle" /> that encapsulates the native handle.</returns>
101 <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="millisecondsTimeOutInterval" /> parameter is less than -1.</exception>
103 <member name="M:System.Threading.ThreadPool.RegisterWaitForSingleObject(System.Threading.WaitHandle,System.Threading.WaitOrTimerCallback,System.Object,System.Int64,System.Boolean)">
104 <summary>Registers a delegate to wait for a <see cref="T:System.Threading.WaitHandle" />, specifying a 64-bit signed integer for the time-out in milliseconds.</summary>
105 <param name="waitObject">The <see cref="T:System.Threading.WaitHandle" /> to register. Use a <see cref="T:System.Threading.WaitHandle" /> other than <see cref="T:System.Threading.Mutex" />.</param>
106 <param name="callBack">The <see cref="T:System.Threading.WaitOrTimerCallback" /> delegate to call when the <paramref name="waitObject" /> parameter is signaled.</param>
107 <param name="state">The object passed to the delegate.</param>
108 <param name="millisecondsTimeOutInterval">The time-out in milliseconds. If the <paramref name="millisecondsTimeOutInterval" /> parameter is 0 (zero), the function tests the object's state and returns immediately. If <paramref name="millisecondsTimeOutInterval" /> is -1, the function's time-out interval never elapses.</param>
109 <param name="executeOnlyOnce">
110 <see langword="true" /> to indicate that the thread will no longer wait on the <paramref name="waitObject" /> parameter after the delegate has been called; <see langword="false" /> to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.</param>
111 <returns>The <see cref="T:System.Threading.RegisteredWaitHandle" /> that encapsulates the native handle.</returns>
112 <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="millisecondsTimeOutInterval" /> parameter is less than -1.</exception>
114 <member name="M:System.Threading.ThreadPool.RegisterWaitForSingleObject(System.Threading.WaitHandle,System.Threading.WaitOrTimerCallback,System.Object,System.TimeSpan,System.Boolean)">
115 <summary>Registers a delegate to wait for a <see cref="T:System.Threading.WaitHandle" />, specifying a <see cref="T:System.TimeSpan" /> value for the time-out.</summary>
116 <param name="waitObject">The <see cref="T:System.Threading.WaitHandle" /> to register. Use a <see cref="T:System.Threading.WaitHandle" /> other than <see cref="T:System.Threading.Mutex" />.</param>
117 <param name="callBack">The <see cref="T:System.Threading.WaitOrTimerCallback" /> delegate to call when the <paramref name="waitObject" /> parameter is signaled.</param>
118 <param name="state">The object passed to the delegate.</param>
119 <param name="timeout">The time-out represented by a <see cref="T:System.TimeSpan" />. If <paramref name="timeout" /> is 0 (zero), the function tests the object's state and returns immediately. If <paramref name="timeout" /> is -1, the function's time-out interval never elapses.</param>
120 <param name="executeOnlyOnce">
121 <see langword="true" /> to indicate that the thread will no longer wait on the <paramref name="waitObject" /> parameter after the delegate has been called; <see langword="false" /> to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.</param>
122 <returns>The <see cref="T:System.Threading.RegisteredWaitHandle" /> that encapsulates the native handle.</returns>
123 <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="timeout" /> parameter is less than -1.</exception>
124 <exception cref="T:System.NotSupportedException">The <paramref name="timeout" /> parameter is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
126 <member name="M:System.Threading.ThreadPool.RegisterWaitForSingleObject(System.Threading.WaitHandle,System.Threading.WaitOrTimerCallback,System.Object,System.UInt32,System.Boolean)">
127 <summary>Registers a delegate to wait for a <see cref="T:System.Threading.WaitHandle" />, specifying a 32-bit unsigned integer for the time-out in milliseconds.</summary>
128 <param name="waitObject">The <see cref="T:System.Threading.WaitHandle" /> to register. Use a <see cref="T:System.Threading.WaitHandle" /> other than <see cref="T:System.Threading.Mutex" />.</param>
129 <param name="callBack">The <see cref="T:System.Threading.WaitOrTimerCallback" /> delegate to call when the <paramref name="waitObject" /> parameter is signaled.</param>
130 <param name="state">The object passed to the delegate.</param>
131 <param name="millisecondsTimeOutInterval">The time-out in milliseconds. If the <paramref name="millisecondsTimeOutInterval" /> parameter is 0 (zero), the function tests the object's state and returns immediately. If <paramref name="millisecondsTimeOutInterval" /> is -1, the function's time-out interval never elapses.</param>
132 <param name="executeOnlyOnce">
133 <see langword="true" /> to indicate that the thread will no longer wait on the <paramref name="waitObject" /> parameter after the delegate has been called; <see langword="false" /> to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.</param>
134 <returns>The <see cref="T:System.Threading.RegisteredWaitHandle" /> that can be used to cancel the registered wait operation.</returns>
135 <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="millisecondsTimeOutInterval" /> parameter is less than -1.</exception>
137 <member name="M:System.Threading.ThreadPool.SetMaxThreads(System.Int32,System.Int32)">
138 <summary>Sets the number of requests to the thread pool that can be active concurrently. All requests above that number remain queued until thread pool threads become available.</summary>
139 <param name="workerThreads">The maximum number of worker threads in the thread pool.</param>
140 <param name="completionPortThreads">The maximum number of asynchronous I/O threads in the thread pool.</param>
142 <see langword="true" /> if the change is successful; otherwise, <see langword="false" />.</returns>
144 <member name="M:System.Threading.ThreadPool.SetMinThreads(System.Int32,System.Int32)">
145 <summary>Sets the minimum number of threads the thread pool creates on demand, as new requests are made, before switching to an algorithm for managing thread creation and destruction.</summary>
146 <param name="workerThreads">The minimum number of worker threads that the thread pool creates on demand.</param>
147 <param name="completionPortThreads">The minimum number of asynchronous I/O threads that the thread pool creates on demand.</param>
149 <see langword="true" /> if the change is successful; otherwise, <see langword="false" />.</returns>
151 <member name="P:System.Threading.ThreadPool.ThreadCount">
152 <summary>Gets the number of thread pool threads that currently exist.</summary>
153 <returns>The number of thread pool threads that currently exist.</returns>
155 <member name="M:System.Threading.ThreadPool.UnsafeQueueNativeOverlapped(System.Threading.NativeOverlapped*)">
156 <summary>Queues an overlapped I/O operation for execution.</summary>
157 <param name="overlapped">The <see cref="T:System.Threading.NativeOverlapped" /> structure to queue.</param>
159 <see langword="true" /> if the operation was successfully queued to an I/O completion port; otherwise, <see langword="false" />.</returns>
161 <member name="M:System.Threading.ThreadPool.UnsafeQueueUserWorkItem(System.Threading.IThreadPoolWorkItem,System.Boolean)">
162 <summary>Queues the specified work item object to the thread pool.</summary>
163 <param name="callBack">The work item to invoke when a thread in the thread pool picks up the work item.</param>
164 <param name="preferLocal">
165 <see langword="true" /> to prefer queueing the work item in a queue close to the current thread; <see langword="false" /> to prefer queueing the work item to the thread pool's shared queue.</param>
167 <see langword="true" /> if the method succeeds; <see cref="T:System.OutOfMemoryException" /> is thrown if the work item could not be queued.</returns>
168 <exception cref="T:System.ArgumentNullException">
169 <paramref name="callback" /> is <see langword="null" />.</exception>
170 <exception cref="T:System.ArgumentOutOfRangeException">The work item is a <see cref="T:System.Threading.Tasks.Task" />.</exception>
171 <exception cref="T:System.OutOfMemoryException">The work item could not be queued.</exception>
173 <member name="M:System.Threading.ThreadPool.UnsafeQueueUserWorkItem(System.Threading.WaitCallback,System.Object)">
174 <summary>Queues the specified delegate to the thread pool, but does not propagate the calling stack to the worker thread.</summary>
175 <param name="callBack">A <see cref="T:System.Threading.WaitCallback" /> that represents the delegate to invoke when a thread in the thread pool picks up the work item.</param>
176 <param name="state">The object that is passed to the delegate when serviced from the thread pool.</param>
178 <see langword="true" /> if the method succeeds; <see cref="T:System.OutOfMemoryException" /> is thrown if the work item could not be queued.</returns>
179 <exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception>
180 <exception cref="T:System.ApplicationException">An out-of-memory condition was encountered.</exception>
181 <exception cref="T:System.OutOfMemoryException">The work item could not be queued.</exception>
182 <exception cref="T:System.ArgumentNullException">
183 <paramref name="callBack" /> is <see langword="null" />.</exception>
185 <member name="M:System.Threading.ThreadPool.UnsafeQueueUserWorkItem``1(System.Action{``0},``0,System.Boolean)">
186 <summary>Queues a method specified by an <see cref="T:System.Action`1" /> delegate for execution, and specifies an object containing data to be used by the method. The method executes when a thread pool thread becomes available.</summary>
187 <param name="callBack">A delegate representing the method to execute.</param>
188 <param name="state">An object containing data to be used by the method.</param>
189 <param name="preferLocal">
190 <see langword="true" /> to prefer queueing the work item in a queue close to the current thread; <see langword="false" /> to prefer queueing the work item to the thread pool's shared queue.</param>
191 <typeparam name="TState">The type of elements of <paramref name="state" />.</typeparam>
193 <see langword="true" /> if the method is successfully queued; <see cref="T:System.NotSupportedException" /> is thrown if the work item could not be queued.</returns>
194 <exception cref="T:System.ArgumentNullException">
195 <paramref name="callback" /> is <see langword="null" />.</exception>
196 <exception cref="T:System.NotSupportedException">The work item could not be queued.</exception>
198 <member name="M:System.Threading.ThreadPool.UnsafeRegisterWaitForSingleObject(System.Threading.WaitHandle,System.Threading.WaitOrTimerCallback,System.Object,System.Int32,System.Boolean)">
199 <summary>Registers a delegate to wait for a <see cref="T:System.Threading.WaitHandle" />, using a 32-bit signed integer for the time-out in milliseconds. This method does not propagate the calling stack to the worker thread.</summary>
200 <param name="waitObject">The <see cref="T:System.Threading.WaitHandle" /> to register. Use a <see cref="T:System.Threading.WaitHandle" /> other than <see cref="T:System.Threading.Mutex" />.</param>
201 <param name="callBack">The delegate to call when the <paramref name="waitObject" /> parameter is signaled.</param>
202 <param name="state">The object that is passed to the delegate.</param>
203 <param name="millisecondsTimeOutInterval">The time-out in milliseconds. If the <paramref name="millisecondsTimeOutInterval" /> parameter is 0 (zero), the function tests the object's state and returns immediately. If <paramref name="millisecondsTimeOutInterval" /> is -1, the function's time-out interval never elapses.</param>
204 <param name="executeOnlyOnce">
205 <see langword="true" /> to indicate that the thread will no longer wait on the <paramref name="waitObject" /> parameter after the delegate has been called; <see langword="false" /> to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.</param>
206 <returns>The <see cref="T:System.Threading.RegisteredWaitHandle" /> object that can be used to cancel the registered wait operation.</returns>
207 <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="millisecondsTimeOutInterval" /> parameter is less than -1.</exception>
208 <exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception>
210 <member name="M:System.Threading.ThreadPool.UnsafeRegisterWaitForSingleObject(System.Threading.WaitHandle,System.Threading.WaitOrTimerCallback,System.Object,System.Int64,System.Boolean)">
211 <summary>Registers a delegate to wait for a <see cref="T:System.Threading.WaitHandle" />, specifying a 64-bit signed integer for the time-out in milliseconds. This method does not propagate the calling stack to the worker thread.</summary>
212 <param name="waitObject">The <see cref="T:System.Threading.WaitHandle" /> to register. Use a <see cref="T:System.Threading.WaitHandle" /> other than <see cref="T:System.Threading.Mutex" />.</param>
213 <param name="callBack">The delegate to call when the <paramref name="waitObject" /> parameter is signaled.</param>
214 <param name="state">The object that is passed to the delegate.</param>
215 <param name="millisecondsTimeOutInterval">The time-out in milliseconds. If the <paramref name="millisecondsTimeOutInterval" /> parameter is 0 (zero), the function tests the object's state and returns immediately. If <paramref name="millisecondsTimeOutInterval" /> is -1, the function's time-out interval never elapses.</param>
216 <param name="executeOnlyOnce">
217 <see langword="true" /> to indicate that the thread will no longer wait on the <paramref name="waitObject" /> parameter after the delegate has been called; <see langword="false" /> to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.</param>
218 <returns>The <see cref="T:System.Threading.RegisteredWaitHandle" /> object that can be used to cancel the registered wait operation.</returns>
219 <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="millisecondsTimeOutInterval" /> parameter is less than -1.</exception>
220 <exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception>
222 <member name="M:System.Threading.ThreadPool.UnsafeRegisterWaitForSingleObject(System.Threading.WaitHandle,System.Threading.WaitOrTimerCallback,System.Object,System.TimeSpan,System.Boolean)">
223 <summary>Registers a delegate to wait for a <see cref="T:System.Threading.WaitHandle" />, specifying a <see cref="T:System.TimeSpan" /> value for the time-out. This method does not propagate the calling stack to the worker thread.</summary>
224 <param name="waitObject">The <see cref="T:System.Threading.WaitHandle" /> to register. Use a <see cref="T:System.Threading.WaitHandle" /> other than <see cref="T:System.Threading.Mutex" />.</param>
225 <param name="callBack">The delegate to call when the <paramref name="waitObject" /> parameter is signaled.</param>
226 <param name="state">The object that is passed to the delegate.</param>
227 <param name="timeout">The time-out represented by a <see cref="T:System.TimeSpan" />. If <paramref name="timeout" /> is 0 (zero), the function tests the object's state and returns immediately. If <paramref name="timeout" /> is -1, the function's time-out interval never elapses.</param>
228 <param name="executeOnlyOnce">
229 <see langword="true" /> to indicate that the thread will no longer wait on the <paramref name="waitObject" /> parameter after the delegate has been called; <see langword="false" /> to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.</param>
230 <returns>The <see cref="T:System.Threading.RegisteredWaitHandle" /> object that can be used to cancel the registered wait operation.</returns>
231 <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="timeout" /> parameter is less than -1.</exception>
232 <exception cref="T:System.NotSupportedException">The <paramref name="timeout" /> parameter is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
233 <exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception>
235 <member name="M:System.Threading.ThreadPool.UnsafeRegisterWaitForSingleObject(System.Threading.WaitHandle,System.Threading.WaitOrTimerCallback,System.Object,System.UInt32,System.Boolean)">
236 <summary>Registers a delegate to wait for a <see cref="T:System.Threading.WaitHandle" />, specifying a 32-bit unsigned integer for the time-out in milliseconds. This method does not propagate the calling stack to the worker thread.</summary>
237 <param name="waitObject">The <see cref="T:System.Threading.WaitHandle" /> to register. Use a <see cref="T:System.Threading.WaitHandle" /> other than <see cref="T:System.Threading.Mutex" />.</param>
238 <param name="callBack">The delegate to call when the <paramref name="waitObject" /> parameter is signaled.</param>
239 <param name="state">The object that is passed to the delegate.</param>
240 <param name="millisecondsTimeOutInterval">The time-out in milliseconds. If the <paramref name="millisecondsTimeOutInterval" /> parameter is 0 (zero), the function tests the object's state and returns immediately. If <paramref name="millisecondsTimeOutInterval" /> is -1, the function's time-out interval never elapses.</param>
241 <param name="executeOnlyOnce">
242 <see langword="true" /> to indicate that the thread will no longer wait on the <paramref name="waitObject" /> parameter after the delegate has been called; <see langword="false" /> to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.</param>
243 <returns>The <see cref="T:System.Threading.RegisteredWaitHandle" /> object that can be used to cancel the registered wait operation.</returns>
244 <exception cref="T:System.Security.SecurityException">The caller does not have the required permission.</exception>
246 <member name="T:System.Threading.WaitCallback">
247 <summary>Represents a callback method to be executed by a thread pool thread.</summary>
248 <param name="state">An object containing information to be used by the callback method.</param>
250 <member name="T:System.Threading.WaitOrTimerCallback">
251 <summary>Represents a method to be called when a <see cref="T:System.Threading.WaitHandle" /> is signaled or times out.</summary>
252 <param name="state">An object containing information to be used by the callback method each time it executes.</param>
253 <param name="timedOut">
254 <see langword="true" /> if the <see cref="T:System.Threading.WaitHandle" /> timed out; <see langword="false" /> if it was signaled.</param>