TPRequestResult

Definition

#include <nitro/spi.h>
typedef enum
{
    TP_RESULT_SUCCESS = 0 ,            // Success
    TP_RESULT_INVALID_PARAMETER ,      // Invalid parameter
    TP_RESULT_ILLEGAL_STATUS ,         // Cannot accept instructions in current status
    TP_RESULT_EXCLUSIVE ,              // SPI device is busy
    TP_RESULT_PXI_BUSY                 // PXI communication with ARM7 is busy
}
TPRequestResult;

Elements

TP_RESULT_SUCCESS The process completed normally.
TP_RESULT_INVALID_PARAMETER The request was not executed because the specified parameter was illegal.
TP_RESULT_ILLEGAL_STATUS The request could not be executed because of the internal state of the TP library. For example, this could result from a call to the TP_RequestAutoSamplingStop function while sampling is not in progress.
This could also indicate that processing was suspended because a synchronous function was called from inside an interrupt handler.
MIC_RESULT_EXCLUSIVE A request to start or stop sampling failed.
TP_RESULT_PXI_BUSY A PXI command failed to be sent to the ARM7.

Description

This is a common enumerated type that shows the results of functions that manipulate the Touch Screen. It is used as a return value for synchronous and asynchronous functions, and as the result argument that is passed to the user callback in an asynchronous function.

See Also

TPRecvCallback

Revision History

2009/06/17 Corrected errors.
2009/04/28 Initial version.


CONFIDENTIAL