Enumeration for return status options. More...

This graph shows which files directly or indirectly include this file:

Typedefs
typedef enum RETURN_Status_t	RETURN_Status
	Alias for enum RETURN_Status_t representing return status options.
typedef enum RETURN_Data_Status_t	RETURN_Data_Status
	Alias for enum RETURN_Data_Status_t representing return data status options.

Enumerations
enum	RETURN_Status_t { RETURN_Success =0 , RETURN_Failure , RETURN_Error }
	Defines return status options for functions. More...
enum	RETURN_Data_Status_t { RETURN_Valid =0 , RETURN_Invalid =1 }
	Defines return data status options for functions. More...

Detailed Description

Enumeration for return status options.

This header file defines an enumeration representing different return status options for functions. The enumeration includes success, failure, and error conditions commonly used in function return values.

Note: The provided typedef RETURN_Status offers a convenient alias for the enumeration type, improving code clarity and consistency when specifying function return statuses.

Author: g.raf

Date: 2026-02-14

Version: 1.0 Release

Copyright: Copyright (c) 2026 g.raf Released under the GPLv3 License. (see LICENSE in repository)

Note: This file is part of a larger project and subject to the license specified in the repository. For updates and the complete revision history, see the GitHub repository.

See also: https://github.com/0x007e/shared-return "Shared Return GitHub Repository"

Typedef Documentation

◆ RETURN_Data_Status

typedef enum RETURN_Data_Status_t RETURN_Data_Status

Alias for enum RETURN_Data_Status_t representing return data status options.

◆ RETURN_Status

typedef enum RETURN_Status_t RETURN_Status

Alias for enum RETURN_Status_t representing return status options.

Enumeration Type Documentation

◆ RETURN_Data_Status_t

enum RETURN_Data_Status_t

Defines return data status options for functions.

This enumeration specifies the return data status of functions, including valid and invalid data conditions.

Enumerator
RETURN_Valid	Function executed successfully and returned valid data
RETURN_Invalid	Function executed successfully but returned invalid data

◆ RETURN_Status_t

enum RETURN_Status_t

Defines return status options for functions.

This enumeration specifies the return status of functions, including success, failure, and error conditions.

Enumerator
RETURN_Success	Function executed successfully
RETURN_Failure	Function failed to execute
RETURN_Error	Function encountered an error condition

Typedefs