Export (0) Print
Expand All

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
)

Parameters

timeout
Type: System.TimeSpan

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

Implements

ICommunicationObject.Close(TimeSpan)

ExceptionCondition
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(TimeSpan) and OnClosed.

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

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0

.NET Compact Framework

Supported in: 3.5

Community Additions

ADD
Show:
© 2014 Microsoft