Share via

  • Article

CommunicationObject.BeginClose Method (TimeSpan, AsyncCallback, Object)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

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

Syntax

'Declaration
Public Function BeginClose ( _
    timeout As TimeSpan, _
    callback As AsyncCallback, _
    state As Object _
) As IAsyncResult

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.
  • 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)

Exceptions

Exception Condition
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.

Remarks

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.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.