cpi_wait_obj

Returns the wait object for the channel associated with the specified handle.

Prototype

#include txcpi.h

CPI_WAIT_TYPE cpi_wait_obj ( TX_HANDLE handle)

Argument

Description

handle

TX handle associated with the channel.


Return values

Return value

Description

CPI_INVALID_WAIT_HANDLE

Invalid TX handle.


Details

Use the wait object when calling the host operating system's native wait routine, such as WaitForSingleObject in Windows or poll for UNIX.