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()

Exception Condition
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.

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: