This documentation is archived and is not being maintained.

CommunicationObject.Close Method (TimeSpan)

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)

public void Close (
	TimeSpan timeout
)
public final void Close (
	TimeSpan timeout
)
public final function Close (
	timeout : TimeSpan
)
Not applicable.

Parameters

timeout

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

Exception typeCondition

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.

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 and OnClosed.

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

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0
Show: