![]() |
ScaFaCoS
1.0.1
Scalable Fast Coulomb Solvers
|
public interface definitions for the FCSResult-object that is used for handling the return state of the ScaFaCoS library functions More...
#include "FCSDefinitions.h"
Include dependency graph for FCSResult_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... | |
public interface definitions for the FCSResult-object that is used for handling the return state of the ScaFaCoS library functions
Definition in file FCSResult_p.h.
| #define FCS_RESULT_MAX_FUNCTION_LENGTH 64 |
Definition at line 46 of file FCSResult_p.h.
| #define FCS_RESULT_MAX_MESSAGE_LENGTH 512 |
Definition at line 47 of file FCSResult_p.h.
| #define FCS_RESULT_SUCCESS NULL |
Definition at line 44 of file FCSResult_p.h.
| #define fcsResult_destroy fcs_result_destroy |
Definition at line 84 of file FCSResult_p.h.
| #define fcsResult_getErrorMessage fcs_result_get_message |
Definition at line 86 of file FCSResult_p.h.
| #define fcsResult_getErrorSource fcs_result_get_function |
Definition at line 87 of file FCSResult_p.h.
| #define fcsResult_getReturnCode fcs_result_get_return_code |
Definition at line 85 of file FCSResult_p.h.
| #define fcsResult_printResult fcs_result_print_result |
Definition at line 88 of file FCSResult_p.h.
| 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 FCSResult_p.h.
| void fcs_result_destroy | ( | FCSResult | result | ) |
function to destroy an FCSResult-object
| result | FCSResult-object containing the return state |
| const char* fcs_result_get_function | ( | FCSResult | result | ) |
function to return the function name associated with an return state
| result | FCSResult-object containing the return state |
| const char* fcs_result_get_message | ( | FCSResult | result | ) |
function to return the description message associated with an return state
| result | FCSResult-object containing the return state |
| fcs_int fcs_result_get_return_code | ( | FCSResult | result | ) |
function to return the return code associated with an return state
| result | FCSResult-object containing the return state |
| void fcs_result_print_result | ( | FCSResult | result | ) |
function to print the return state to stdout
| result | FCSResult-object containing the return state |