Share via


CommunicationObject.OnBeginClose Method

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

When implemented in a derived class, inserts processing after a communication object transitions to the closing state due to the invocation of an asynchronous close operation.

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

Syntax

'Declaration
Protected MustOverride Function OnBeginClose ( _
    timeout As TimeSpan, _
    callback As AsyncCallback, _
    state As Object _
) As IAsyncResult
protected abstract IAsyncResult OnBeginClose(
    TimeSpan timeout,
    AsyncCallback callback,
    Object state
)

Parameters

  • timeout
    Type: System.TimeSpan
    The Timespan that specifies how long the on 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 on close operation.

Return Value

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

Exceptions

Exception Condition
ArgumentOutOfRangeException

timeout is less than zero.

Remarks

The BeginClose method calls OnBeginClose if the communication object is initially in the Opened state.

When implemented in a derived class, inserts processing after a communication object transitions to a closing state due to the invocation of a synchronous Close operation, use the OnClose(TimeSpan)method.

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.