Overlapped.Free(NativeOverlapped*) Method

Reference

Definition

Namespace:: System.Threading

Assembly:: System.Threading.Overlapped.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Source:: Overlapped.cs

Source:: Overlapped.cs

Source:: Overlapped.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 unmanaged memory associated with a native overlapped structure allocated by the Pack method.

public:
 static void Free(System::Threading::NativeOverlapped* nativeOverlappedPtr);

[System.CLSCompliant(false)]
public static void Free (System.Threading.NativeOverlapped* nativeOverlappedPtr);

[System.CLSCompliant(false)]
[System.Security.SecurityCritical]
public static void Free (System.Threading.NativeOverlapped* nativeOverlappedPtr);

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

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

Parameters

nativeOverlappedPtr: NativeOverlapped*

A pointer to the NativeOverlapped structure to be freed.

Attributes: CLSCompliantAttribute SecurityCriticalAttribute

Exceptions

ArgumentNullException

nativeOverlappedPtr is null.

Remarks

You must call the Free method exactly once on every NativeOverlapped pointer you receive from the Pack method. If you don't call the Free method, you will leak memory. If you call the Free method more than once, memory will be corrupted.

Applies to

Jaa