fcs_result_p.h File Reference

public interface definitions for the FCSResult-object that is used for handling the return state of the ScaFaCoS library functions More...

#include "fcs_definitions.h"

Include dependency graph for fcs_result_p.h:

Go to the source code of this file.

Macros
#define	FCS_RESULT_SUCCESS   NULL
#define	FCS_RESULT_MAX_FUNCTION_LENGTH   64
#define	FCS_RESULT_MAX_MESSAGE_LENGTH   512
#define	fcsResult_destroy   fcs_result_destroy
#define	fcsResult_getReturnCode   fcs_result_get_return_code
#define	fcsResult_getErrorMessage   fcs_result_get_message
#define	fcsResult_getErrorSource   fcs_result_get_function
#define	fcsResult_printResult   fcs_result_print_result

Typedefs
typedef struct FCSResult_t *	FCSResult
	FCSResult-object that is used for handling the return state of the ScaFaCoS library functions. More...

Functions
void	fcs_result_destroy (FCSResult result)
	function to destroy an FCSResult-object More...
fcs_int	fcs_result_get_return_code (FCSResult result)
	function to return the return code associated with an return state More...
const char *	fcs_result_get_function (FCSResult result)
	function to return the function name associated with an return state More...
const char *	fcs_result_get_message (FCSResult result)
	function to return the description message associated with an return state More...
void	fcs_result_print_result (FCSResult result)
	function to print the return state to stdout More...

Detailed Description

public interface definitions for the FCSResult-object that is used for handling the return state of the ScaFaCoS library functions

Author

Lidia Westphal, Rene Halver, Michael Hofmann

Definition in file fcs_result_p.h.

Macro Definition Documentation

FCS_RESULT_MAX_FUNCTION_LENGTH

#define FCS_RESULT_MAX_FUNCTION_LENGTH   64

Definition at line 46 of file fcs_result_p.h.

FCS_RESULT_MAX_MESSAGE_LENGTH

#define FCS_RESULT_MAX_MESSAGE_LENGTH   512

Definition at line 47 of file fcs_result_p.h.

FCS_RESULT_SUCCESS

#define FCS_RESULT_SUCCESS   NULL

Definition at line 44 of file fcs_result_p.h.

fcsResult_destroy

#define fcsResult_destroy   fcs_result_destroy

Definition at line 84 of file fcs_result_p.h.

fcsResult_getErrorMessage

#define fcsResult_getErrorMessage   fcs_result_get_message

Definition at line 86 of file fcs_result_p.h.

fcsResult_getErrorSource

#define fcsResult_getErrorSource   fcs_result_get_function

Definition at line 87 of file fcs_result_p.h.

fcsResult_getReturnCode

#define fcsResult_getReturnCode   fcs_result_get_return_code

Definition at line 85 of file fcs_result_p.h.

fcsResult_printResult

#define fcsResult_printResult   fcs_result_print_result

Definition at line 88 of file fcs_result_p.h.

Typedef Documentation

FCSResult

typedef struct FCSResult_t* FCSResult

FCSResult-object that is used for handling the return state of the ScaFaCoS library functions.

Definition at line 42 of file fcs_result_p.h.

Function Documentation

fcs_result_destroy()

void fcs_result_destroy

(

FCSResult

result

)

function to destroy an FCSResult-object

Parameters

result

FCSResult-object containing the return state

fcs_result_get_function()

const char* fcs_result_get_function

(

FCSResult

result

)

function to return the function name associated with an return state

Parameters

result

FCSResult-object containing the return state

Returns

function name associated with the return state

fcs_result_get_message()

const char* fcs_result_get_message

(

FCSResult

result

)

function to return the description message associated with an return state

Parameters

result

FCSResult-object containing the return state

Returns

description message associated with the return state

fcs_result_get_return_code()

fcs_int fcs_result_get_return_code

(

FCSResult

result

)

function to return the return code associated with an return state

Parameters

result

FCSResult-object containing the return state

Returns

return code associated with the return state

fcs_result_print_result()

void fcs_result_print_result

(

FCSResult

result

)

function to print the return state to stdout

Parameters

result

FCSResult-object containing the return state