cpia_chkey

Returns the user-provided key associated with the specified handle.

Prototype

#include txcpi.h

void *cpia_chkey ( TX_HANDLE handle)

Argument

Description

handle

TX_HANDLE associated with the channel.


Return values

Return value

Description

NULL

Provided TX handle is not a handle to an asynchronous channel.


Details

One of the parameters provided to cpia_open or cpix_open is a user-controlled key named chkey. Applications can use cpia_chkey to get the key associated with the open. For asynchronous receive and transmit complete notifications, it is not necessary to call cpia_chkey since the user’s key is provided as a parameter to cpia_rxnotify and cpia_txnotify.