Export (0) Print
Expand All

ICommunicationObject.Close Method

Causes a communication object to transition from its current state into the closed state.

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

void Close()

ExceptionCondition
CommunicationObjectFaultedException

Close was called on an object in the Faulted state.

TimeoutException

The default close timeout elapsed before the ICommunicationObject was able to close gracefully.

This method causes an ICommunicationObject to gracefully transition from the Opened state to the Closed state. The Close method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages).

The ICommunicationObject enters the Closing state and remains in it until the transition to the Closed state is completed.

Close returns once the Closed state is reached.

If the default close timeout elapses before the ICommunicationObject is able to close gracefully, the ICommunicationObject is aborted.

If Close is called on an ICommunicationObject in the Created, Opening, or Faulted state, the ICommunicationObject is aborted. If Close is called on an ICommunicationObject in the Closing or Closed state, the call returns immediately.

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

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft