1.5.3.7 PAL_RF_TxCancel Function

C

void PAL_RF_TxCancel(PAL_RF_HANDLE handle, PAL_RF_TX_HANDLE txHandle);

Summary

Allows a client to cancel a previously requested transmission.

Description

This routine allows a client to cancel a previously requested transmission.

Precondition

PAL_RF_HandleGet must have been called to obtain a valid RF PAL handle.

PAL_RF_TxRequest must have been called to obtain a valid transmission handle.

Parameters


Param	Description
handle	A valid handle, returned from PAL_RF_HandleGet.
txHandle	A valid transmission handle, returned from PAL_RF_TxRequest.

Returns

None.

Example

PAL_RF_HANDLE palRfHandle; // returned from PAL_RF_HandleGet
PAL_RF_TX_HANDLE txReqHandle; // returned from PAL_RF_TxRequest

PAL_RF_TxCancel(palRfHandle, txReqHandle);

Remarks

If transmission has already started it will be aborted before completion.