ThreadPoolBoundHandle.FreeNativeOverlapped(NativeOverlapped*) Method

Reference

Definition

Namespace:: System.Threading

Assemblies:: mscorlib.dll, System.Threading.Overlapped.dll

Assembly:: System.Threading.Overlapped.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Source:: ThreadPoolBoundHandle.cs

Source:: ThreadPoolBoundHandle.Unix.cs

Source:: ThreadPoolBoundHandle.Unix.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Important

This API is not CLS-compliant.

Frees the memory associated with a NativeOverlapped structure allocated by the AllocateNativeOverlapped method.

public:
 void FreeNativeOverlapped(System::Threading::NativeOverlapped* overlapped);

[System.CLSCompliant(false)]
public void FreeNativeOverlapped (System.Threading.NativeOverlapped* overlapped);

[System.CLSCompliant(false)]
[System.Security.SecurityCritical]
public void FreeNativeOverlapped (System.Threading.NativeOverlapped* overlapped);

[<System.CLSCompliant(false)>]
member this.FreeNativeOverlapped : nativeptr<System.Threading.NativeOverlapped> -> unit

[<System.CLSCompliant(false)>]
[<System.Security.SecurityCritical>]
member this.FreeNativeOverlapped : nativeptr<System.Threading.NativeOverlapped> -> unit

Parameters

overlapped: NativeOverlapped*

An unmanaged pointer to the NativeOverlapped structure to be freed.

Attributes: CLSCompliantAttribute SecurityCriticalAttribute

Exceptions

ArgumentNullException

overlapped is null.

ObjectDisposedException

This method was called after the ThreadPoolBoundHandle object was disposed.

Remarks

Caution

You must call the FreeNativeOverlapped method exactly once on every NativeOverlapped unmanaged pointer allocated by using the AllocateNativeOverlapped method. If you do not call the FreeNativeOverlapped method, you will leak memory. If you call the FreeNativeOverlapped method more than once on the same NativeOverlapped unmanaged pointer, memory will be corrupted.

Applies to