HIOClose

Syntax

#include <cafe.h>
#include <cafe/hio.h>

HIOStatus HIOClose(HIOHandle handle);

Parameters

handle Handle of the channel to be closed.

Return Values

HIO_STATUS_OK The handle was successfully closed.
HIO_STATUS_INVALID_HANDLE The handle was invalid.
< 0 The close operation failed.

Description

Closes the channel as specified by handle. After a channel has been closed, its associated connection callback will never be invoked. The user is responsible for completing outstanding transactions before closing the channel.

Do Not Call From

Callbacks Do not call this function from any callback function.
Interrupt handler Do not call this function from any interrupt handler.
Exception handler Do not call this function from any exception handler.
Production code Do not call this function in production code. It is available only for debugging purposes.

See Also

HIOOpen
HIOOpenEx

Revision History

2013-05-08 Automated cleanup pass.
2011-11-04 Updated return values.
2011-02-21 Initial version.


CONFIDENTIAL