ICommunicationObject::BeginClose Method (TimeSpan, AsyncCallback^, Object^)

.NET Framework (current version)

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

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

Syntax

IAsyncResult^ BeginClose(
	TimeSpan timeout,
	AsyncCallback^ callback,
	Object^ state
)

Parameters

timeout: Type: System::TimeSpan
The TimeSpan that specifies how long the send 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.

Exceptions

Exception	Condition
CommunicationObjectFaultedException	M:System.ServiceModel.ICommunicationObject.BeginClose was called on an object in the Faulted state.
TimeoutException	The specified 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 with in a specified interval of time. The M:System.ServiceModel.ICommunicationObject.BeginClose method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages).

Version Information

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0