common.c File Reference

#include "common.h"

Go to the source code of this file.

Functions
bool	my_rc_e_is_notok (my_rc_e rc)
bool	my_rc_e_is_ok (my_rc_e rc)
bool	my_rc_e_is_valid (my_rc_e rc)
const char *	my_rc_e_get_string (my_rc_e rc)

---

Detailed Description

Author:

Matt Miller <matt@matthewjmiller.net>

LICENSE

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

DESCRIPTION

This implements some common functions.

Definition in file common.c.

---

Function Documentation

const char* my_rc_e_get_string

(

my_rc_e

rc

)

Get a string representation of the return code.

Parameters:

rc	The return code

Returns:

A string representation of the return code or "__Invalid__" if an invalid return code is input.

Definition at line 88 of file common.c.

bool my_rc_e_is_notok

(

my_rc_e

rc

)

Indicates whether the return code is not in error.

Parameters:

rc	The return code to check

Returns:

true if the return code is not in error.

Definition at line 51 of file common.c.

bool my_rc_e_is_ok

(

my_rc_e

rc

)

Indicates whether the return code is in error.

Parameters:

rc	The return code to check

Returns:

true if the return code is not in error.

Definition at line 63 of file common.c.

bool my_rc_e_is_valid

(

my_rc_e

rc

)

Indicates whether the return code is valid.

Parameters:

rc	The return code to check

Returns:

true if the return code is valid.

Definition at line 75 of file common.c.