define_error_flags.h File Reference

Defines error flag type for indicating detected errors in Middleware services. More...

Go to the source code of this file.

Enumerations
enum	errFlag_t { NO_ERROR = 0x55 , ERROR = 0xAA }
	Defines the error flag used by Middleware services to indicate error detection. More...

Detailed Description

Defines error flag type for indicating detected errors in Middleware services.

Copyright

© 2024 Microchip Technology Inc. and its subsidiaries.

Subject to your compliance with these terms, you may use Microchip software and any derivatives exclusively with Microchip products. It is your responsibility to comply with third party license terms applicable to your use of third party software (including open source software) that may accompany Microchip software.

THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.

IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY, THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.

Definition in file define_error_flags.h.

Enumeration Type Documentation

errFlag_t

enum errFlag_t

Defines the error flag used by Middleware services to indicate error detection.

This enum is returned to Tasks by Middleware services to signify whether an error was detected during their execution. The flag can be passed to EH_HandleError to evaluate if error handling is necessary or if operations can proceed normally.

Error conditions can include incorrect input parameters, an invalid state, or diagnostic failures. For details on what constitutes an error, refer to the documentation of individual Middleware functions.

Warning

Certain Tasks relies on these values being non-zero in order to combine error flag results.

Enumerator
NO_ERROR	Indicates no error was detected, allowing normal operation
ERROR	Indicates an error was detected, requiring error handling

Definition at line 41 of file define_error_flags.h.