ARGXAddError.h File Reference

#include "types.h"

Go to the source code of this file.

Data Structures
struct	ArgxcErrorPair

Functions
ArgxcError	argxcCreateErrorSimple (const char *msg, const char *help)
int	argxcGetErrorCode (const ArgxcError *error)
const char *	argxcGetErrorHelp (const ArgxcError *error)
const char *	argxcGetErrorMessage (const ArgxcError *error)
ArgxcErrorPair	argxcGetErrorPair (const ArgxcError *error)

Function Documentation

argxcCreateErrorSimple()

ArgxcError argxcCreateErrorSimple	(	const char *	msg,
		const char *	help )

Definition at line 19 of file ARGXAddError.c.

{
    ArgxcError error = {0};
 
    error.type = stringDuplicate("error");
    error.error = stringDuplicate(msg);
    error.help = stringDuplicate(help);
    error.code = 1; // Default error code
 
    return error;
}

References ArgxcError::code, ArgxcError::error, ArgxcError::help, stringDuplicate(), and ArgxcError::type.

argxcGetErrorCode()

int argxcGetErrorCode

(

const ArgxcError *

error

)

Definition at line 41 of file ARGXAddError.c.

{
    return error ? error->code : 0;
}

References ArgxcError::code.

argxcGetErrorHelp()

const char * argxcGetErrorHelp

(

const ArgxcError *

error

)

Definition at line 36 of file ARGXAddError.c.

{
    return error ? error->help : NULL;
}

References ArgxcError::help.

argxcGetErrorMessage()

const char * argxcGetErrorMessage

(

const ArgxcError *

error

)

Definition at line 31 of file ARGXAddError.c.

{
    return error ? error->error : NULL;
}

References ArgxcError::error.

argxcGetErrorPair()

ArgxcErrorPair argxcGetErrorPair

(

const ArgxcError *

error

)

Definition at line 46 of file ARGXAddError.c.

{
    ArgxcErrorPair pair = {NULL, NULL};
 
    if (error)
    {
        pair.error = error->error;
        pair.help = error->help;
    }
 
    return pair;
}

References ArgxcError::error, ArgxcErrorPair::error, ArgxcError::help, and ArgxcErrorPair::help.