• Article

CommunicationObject.Close Method (TimeSpan)

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

Causes a communication object to transition from its current state into the closed state within a specified interval of time.

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

Syntax

'Declaration
Public Sub Close ( _
    timeout As TimeSpan _
)

public void Close(
    TimeSpan timeout
)

Parameters

  • timeout
    Type: System.TimeSpan
    The Timespan that specifies how long the close operation has to complete before timing out.

Implements

ICommunicationObject.Close(TimeSpan)

Exceptions

Exception Condition
CommunicationObjectFaultedException

Close 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 a CommunicationObject to gracefully transition from any state, other than the Closed state, into the Closed state within a specified interval of time. The Close method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages.

The CommunicationObject enters the Closing state and remains in it after the Close method is called until the transition to the Closed state is completed. The transition consists of making successive calls to OnClosing, OnClose(TimeSpan) and OnClosed.

There is also an asynchronous version of the close method that is initiated by calling BeginClose.

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.