RTCResult

Definitions

#include <nitro/rtc.h>
typedef enum
{ 
	RTC_RESULT_SUCCESS = 0 ,
	RTC_RESULT_BUSY ,
	RTC_RESULT_ILLEGAL_PARAMETER ,
	RTC_RESULT_SEND_ERROR ,
	RTC_RESULT_INVALID_COMMAND ,
	RTC_RESULT_ILLEGAL_STATUS ,
	RTC_RESULT_FATAL_ERROR ,
	RTC_RESULT_MAX

} RTCResult;

Elements

RTC_RESULT_SUCCESS Indicates that the process completed normally.
RTC_RESULT_BUSY Indicates that the request could not be performed because another RTC operation was being processed at the same time.
RTC_RESULT_ILLEGAL_PARAMETER Indicates that the request was not performed because the specified parameter was illegal.
RTC_RESULT_SEND_ERROR Indicates the failure of a request to ARM7 that was issued using PXI communications.
RTC_RESULT_INVALID_COMMAND Indicates that the request could not be performed because the request received by ARM7 was not a supported command.
RTC_RESULT_ILLEGAL_STATUS Indicates that the request could not be performed because of RTC internal status.
This error is not generated during normal application of the RTC library.
RTC_RESULT_FATAL_ERROR Indicates that proper process was not possible due to a cause not listed above.
This error is not generated during normal application of the RTC library.

Description

This is an enumerator that indicates the result for a function that manipulates the real time clock.
It is used as a return value for synchronous and asynchronous functions, and the result argument that is passed to the user callback in an asynchronous function.

See Also

RTCCallback

Revision History

Ver. 08/10/2006 Added a description related to some internaldd
Ver. 05/18/2004 Initial version.


CONFIDENTIAL