This documentation is archived and is not being maintained.

CommunicationObject.OnClose Method

Inserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous close operation.

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

protected abstract void OnClose(
	TimeSpan timeout
)

Parameters

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

ExceptionCondition
CommunicationObjectFaultedException

Close was called on an object in the Faulted state.

TimeoutException

The default interval of time that was allotted for the operation was exceeded before the operation was completed.

CommunicationException

A communication error occurred while closing the object.

The Close method calls OnClose if the communication object is initially in the Opened state.

To insert processing after a communication object transitions to a closing state due to the invocation of an asynchronous BeginClose operation, use the OnBeginClose method.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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