Control.EndInvoke Method (System.Windows.Forms)

EndInvoke Method

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

Control..::.EndInvoke Method

Updated: November 2007

Retrieves the return value of the asynchronous operation represented by the IAsyncResult passed.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)

Syntax

Visual Basic (Declaration)

Public Function EndInvoke ( _
    asyncResult As IAsyncResult _
) As Object

Visual Basic (Usage)

Dim instance As Control
Dim asyncResult As IAsyncResult
Dim returnValue As Object

returnValue = instance.EndInvoke(asyncResult)

public Object EndInvoke(
    IAsyncResult asyncResult
)

Visual C++

public:
virtual Object^ EndInvoke(
    IAsyncResult^ asyncResult
) sealed

public final Object EndInvoke(
    IAsyncResult asyncResult
)

JScript

public final function EndInvoke(
    asyncResult : IAsyncResult
) : Object

Parameters

asyncResult: Type: System..::.IAsyncResult
The IAsyncResult that represents a specific invoke asynchronous operation, returned when calling BeginInvoke.

Return Value

Type: System..::.Object

The Object generated by the asynchronous operation.

Implements

ISynchronizeInvoke..::.EndInvoke(IAsyncResult)

Exceptions

Exception	Condition
ArgumentNullException	The asyncResult parameter value is nullNothingnullptra null reference (Nothing in Visual Basic).
ArgumentException	The asyncResult object was not created by a preceding call of the BeginInvoke method from the same control.

Remarks

If the asynchronous operation has not been completed, this function will block until the result is available.

Note:
In addition to the InvokeRequired property, there are four methods on a control that are thread safe: Invoke, BeginInvoke, EndInvoke, and CreateGraphics if the handle for the control has already been created. Calling CreateGraphics before the control's handle has been created on a background thread can cause illegal cross thread calls. For all other method calls, you should use one of the invoke methods to marshal the call to the control's thread.

Note:

In addition to the InvokeRequired property, there are four methods on a control that are thread safe: Invoke, BeginInvoke, EndInvoke, and CreateGraphics if the handle for the control has already been created. Calling CreateGraphics before the control's handle has been created on a background thread can cause illegal cross thread calls. For all other method calls, you should use one of the invoke methods to marshal the call to the control's thread.

Platforms

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information