CommunicationObject.Close Method (TimeSpan)
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Causes a communication object to transition from its current state into the closed state within a specified interval of time.
Assembly: System.ServiceModel (in System.ServiceModel.dll)
Parameters
- timeout
- Type: System.TimeSpan
The TimeSpan that specifies how long the close operation has to complete before timing out.
Implements
ICommunicationObject.Close(TimeSpan)| Exception | Condition |
|---|---|
| CommunicationObjectFaultedException | |
| 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.