ThreadPoolBoundHandle.GetNativeOverlappedState(NativeOverlapped*) Method

Definition

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.

Returns the user-provided object that was specified when the NativeOverlapped instance was allocated by calling the AllocateNativeOverlapped(IOCompletionCallback, Object, Object) method.

C#
[System.CLSCompliant(false)]
public static object GetNativeOverlappedState(System.Threading.NativeOverlapped* overlapped);
C#
[System.CLSCompliant(false)]
public static object? GetNativeOverlappedState(System.Threading.NativeOverlapped* overlapped);
C#
[System.CLSCompliant(false)]
[System.Security.SecurityCritical]
public static object GetNativeOverlappedState(System.Threading.NativeOverlapped* overlapped);

Parameters

overlapped
NativeOverlapped*

An unmanaged pointer to the NativeOverlapped structure from which to return the associated user-provided object.

Returns

A user-provided object that distinguishes this NativeOverlapped instance from other NativeOverlapped instances, or null if one was not specified when the instance was allocated by calling the AllocateNativeOverlapped method.

Attributes

Exceptions

overlapped is null.

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1
UWP 10.0