bps_channel_destroy()

#include <bps/bps.h>
 

BPS_API int bps_channel_destroy(int chid)

Since:

BlackBerry 10.0.0

Arguments:

chid

The channel ID set by a call to the bps_channel_create() function.

Library:

libbps (For the qcc command, use the -l bps option to link against this library)

Description:

After an application is finished using the channel, call the bps_channel_destroy() function for channels that are created using the bps_channel_create() function. After this function is called, all events that are waiting in the channel's event queue are completed and all callbacks registered with the bps_register_channel_destroy_handler() function are called.

When the chid argument is the thread's active channel, it is destroyed and the default channel for the thread is set as the active channel.

Returns:

BPS_SUCCESS when the function completes successfully, BPS_FAILURE with errno value set otherwise.