Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

CommunicationObject.BeginClose Method (TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to close a communication object with a specified timeout.

Namespace:  System.ServiceModel.Channels
Assembly:  System.ServiceModel (in System.ServiceModel.dll)
public IAsyncResult BeginClose(
	TimeSpan timeout,
	AsyncCallback callback,
	Object state
)

Parameters

timeout
Type: System.TimeSpan

The Timespan that specifies how long the close operation has to complete before timing out.

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.

Implements

ICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object)
ExceptionCondition
CommunicationObjectFaultedException

BeginClose was called on an object in the Faulted state.

ArgumentOutOfRangeException

timeout is less than zero.

TimeoutException

The interval of time specified by timeout that was allotted for the operation was exceeded before the operation was completed.

This method causes the CommunicationObject to gracefully transition from any state, other than the Closed state, into the Closed state with in a specified interval of time. The BeginClose method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages). This method calls OnBeginClose(TimeSpan, AsyncCallback, Object) if the communication object was initially in the Opened state.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, 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.

.NET Framework

Supported in: 3.5, 3.0

.NET Compact Framework

Supported in: 3.5
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.