fcs_result_p.h

Go to the documentation of this file.

/*
  Copyright (C) 2011, 2012, 2013 Lidia Westphal, Rene Halver, Michael Hofmann

  This file is part of ScaFaCoS.

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

  ScaFaCoS 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 Lesser Public License for more details.

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


#ifndef _FCSRESULT_P_H
#define _FCSRESULT_P_H

#include "fcs_definitions.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct FCSResult_t *FCSResult;

#define FCS_RESULT_SUCCESS  NULL

#define FCS_RESULT_MAX_FUNCTION_LENGTH   64
#define FCS_RESULT_MAX_MESSAGE_LENGTH   512

void fcs_result_destroy(FCSResult result);

fcs_int fcs_result_get_return_code(FCSResult result);

const char *fcs_result_get_function(FCSResult result);

const char *fcs_result_get_message(FCSResult result);

void fcs_result_print_result(FCSResult result);


#ifdef FCS_ENABLE_DEPRECATED
#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
#endif


#ifdef __cplusplus
}
#endif


#endif