Important: The information in this document is obsolete and should not be used for new development.
OTRcvOrderlyDisconnect
Clears an incoming orderly disconnect event.C INTERFACE
OSStatus OTRcvOrderlyDisconnect(EndpointREf ref);C++ INTERFACE
OSStatus TEndpoint::RcvOrderlyDisconnect();PARAMETERS
ref- The endpoint reference of the endpoint acknowledging receipt of the disconnect request.
- function result
- An error code. See Appendix B.
DISCUSSION
You call theOTRcvOrderlyDisconnectfunction to acknowledge the receipt of an orderly disconnect event. After using theOTRcvOrderlyDisconnectfunction, there will not be any more data to receive. Attempts to receive data will fail with thekOTOutStateErrresult. If the endpoint supports a remote orderly disconnect, you can still send data over the connection if you have not yet called theOTSndOrderlyDisconnectfunction.The
OTRcvOrderlyDisconnectfunction behaves in the same way in all modes of operation. If there is no disconnection request pending, the function returns with thekOTNoReleaseErrresult. If there is a disconnection request pending, the function returns thekOTNoErrorresult.The
OTRcvOrderlyDisconnectfunction is only supported by those protocols that have aservtypefield of theTEndpointInfostructure with a valueT_COTS_ORDorT_TRANS_ORD.SEE ALSO
"Terminating a Connection".