err.h File Reference

Global error state of the MRE. More...

Go to the source code of this file.

Enumerations
enum	AERErrCode {   AER_TRY = -1 , AER_OK = 0 , AER_NULL_ARG = 1 , AER_SEQ_BREAK = 2 ,   AER_OUT_OF_MEM = 3 , AER_FAILED_LOOKUP = 4 , AER_FAILED_PARSE = 5 , AER_BAD_FILE = 6 ,   AER_BAD_VAL = 7 }
	Possible values of aererr. More...

Variables
AERErrCode	aererr
	Error state of most recently called MRE function. More...

Detailed Description

Global error state of the MRE.

Since

1.0.0

Copyright

2021 the libaermre authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Enumeration Type Documentation

AERErrCode

enum AERErrCode

Possible values of aererr.

Since

1.0.0

Enumerator
AER_TRY	Flag that informs the MRE that the next public function call is being error-checked. Functions will never report this error. Since 1.3.0
AER_OK	Function did not report an error. Deprecated: Partially since 1.3.0. This symbol, itself, is not deprecated, but setting aererr to it when error-checking a function is deprecated. Instead, use AER_TRY. Functions will still report this if they did not encounter any errors; this functionality is not deprecated. Since 1.0.0
AER_NULL_ARG	Function received NULL pointer argument. Since 1.0.0
AER_SEQ_BREAK	Function called at incorrect stage of runtime execution. Since 1.0.0
AER_OUT_OF_MEM	Function unable to allocate necessary memory required for proper execution. Deprecated: Since 1.1.0. Since 1.0.0
AER_FAILED_LOOKUP	Function called with an invalid index, ID or key. Since 1.0.0
AER_FAILED_PARSE	Function unable to parse resource. Since 1.0.0
AER_BAD_FILE	Function unable to read file. Since 1.0.0
AER_BAD_VAL	Function encountered an invalid value or combination of values. Since 1.0.0

Variable Documentation

aererr

AERErrCode aererr

extern

Error state of most recently called MRE function.

Note

Always reset this global to AER_TRY before calling the function to be error-checked.

Since

1.0.0