This documentation is archived and is not being maintained.

ICommunicationObject.BeginClose Method (AsyncCallback, Object)

Begins an asynchronous operation to close a communication object.

Namespace:  System.ServiceModel
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

IAsyncResult BeginClose(
	AsyncCallback callback,
	Object state
)

Parameters

callback
Type: System.AsyncCallback
The AsyncCallback delegate that receives notification of the completion of the asynchronous close operation.
state
Type: System.Object
An object, specified by the application, that contains state information associated with the asynchronous close operation.

Return Value

Type: System.IAsyncResult
The IAsyncResult that references the asynchronous close operation.

ExceptionCondition
CommunicationObjectFaultedException

BeginClose() was called on an object in the Faulted state.

TimeoutException

The default timeout elapsed before the ICommunicationObject was able to close gracefully.

This method causes an ICommunicationObject to gracefully transition from any state, other than the Opened state to the Closed state. The BeginClose() method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages).

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: