IPhreeqc.h

Go to the documentation of this file.

#ifndef INC_IPHREEQC_H
#define INC_IPHREEQC_H

#include "Var.h"

typedef enum {
        IPQ_OK            =  0,  
        IPQ_OUTOFMEMORY   = -1,  
        IPQ_BADVARTYPE    = -2,  
        IPQ_INVALIDARG    = -3,  
        IPQ_INVALIDROW    = -4,  
        IPQ_INVALIDCOL    = -5,  
        IPQ_BADINSTANCE   = -6   
} IPQ_RESULT;


#if defined(__cplusplus)
extern "C" {
#endif

        IPQ_DLL_EXPORT IPQ_RESULT  AccumulateLine(int id, const char *line);


        IPQ_DLL_EXPORT int         AddError(int id, const char* error_msg);


        IPQ_DLL_EXPORT int         AddWarning(int id, const char* warn_msg);



        IPQ_DLL_EXPORT IPQ_RESULT  ClearAccumulatedLines(int id);


        IPQ_DLL_EXPORT int         CreateIPhreeqc(void);


        IPQ_DLL_EXPORT IPQ_RESULT  DestroyIPhreeqc(int id);


        IPQ_DLL_EXPORT const char* GetComponent(int id, int n);


        IPQ_DLL_EXPORT int         GetComponentCount(int id);

        IPQ_DLL_EXPORT int         GetCurrentSelectedOutputUserNumber(int id);

        IPQ_DLL_EXPORT const char* GetDumpFileName(int id);


        IPQ_DLL_EXPORT int         GetDumpFileOn(int id);


        IPQ_DLL_EXPORT const char* GetDumpString(int id);


        IPQ_DLL_EXPORT const char* GetDumpStringLine(int id, int n);


        IPQ_DLL_EXPORT int         GetDumpStringLineCount(int id);


        IPQ_DLL_EXPORT int         GetDumpStringOn(int id);


        IPQ_DLL_EXPORT const char* GetErrorFileName(int id);


        IPQ_DLL_EXPORT int         GetErrorFileOn(int id);


        IPQ_DLL_EXPORT const char* GetErrorString(int id);


        IPQ_DLL_EXPORT const char* GetErrorStringLine(int id, int n);


        IPQ_DLL_EXPORT int         GetErrorStringLineCount(int id);

        IPQ_DLL_EXPORT int         GetErrorStringOn(int id);

        IPQ_DLL_EXPORT const char* GetLogFileName(int id);


        IPQ_DLL_EXPORT int         GetLogFileOn(int id);


        IPQ_DLL_EXPORT const char* GetLogString(int id);


        IPQ_DLL_EXPORT const char* GetLogStringLine(int id, int n);

        IPQ_DLL_EXPORT int         GetLogStringLineCount(int id);


        IPQ_DLL_EXPORT int         GetLogStringOn(int id);


        IPQ_DLL_EXPORT int         GetNthSelectedOutputUserNumber(int id, int n);

        IPQ_DLL_EXPORT const char* GetOutputFileName(int id);


        IPQ_DLL_EXPORT int         GetOutputFileOn(int id);

        IPQ_DLL_EXPORT const char* GetOutputString(int id);

        IPQ_DLL_EXPORT const char* GetOutputStringLine(int id, int n);

        IPQ_DLL_EXPORT int         GetOutputStringLineCount(int id);

        IPQ_DLL_EXPORT int         GetOutputStringOn(int id);


        IPQ_DLL_EXPORT int         GetSelectedOutputColumnCount(int id);

        IPQ_DLL_EXPORT int         GetSelectedOutputCount(int id);


        IPQ_DLL_EXPORT const char* GetSelectedOutputFileName(int id);


        IPQ_DLL_EXPORT int         GetSelectedOutputFileOn(int id);


        IPQ_DLL_EXPORT int         GetSelectedOutputRowCount(int id);


        IPQ_DLL_EXPORT const char* GetSelectedOutputString(int id);


        IPQ_DLL_EXPORT const char* GetSelectedOutputStringLine(int id, int n);


        IPQ_DLL_EXPORT int         GetSelectedOutputStringLineCount(int id);


        IPQ_DLL_EXPORT int         GetSelectedOutputStringOn(int id);


        IPQ_DLL_EXPORT IPQ_RESULT  GetSelectedOutputValue(int id, int row, int col, VAR* pVAR);


        IPQ_DLL_EXPORT IPQ_RESULT  GetSelectedOutputValue2(int id, int row, int col, int *vtype, double* dvalue, char* svalue, unsigned int svalue_length);


        IPQ_DLL_EXPORT const char* GetVersionString(void);


        IPQ_DLL_EXPORT const char* GetWarningString(int id);


        IPQ_DLL_EXPORT const char* GetWarningStringLine(int id, int n);


        IPQ_DLL_EXPORT int         GetWarningStringLineCount(int id);


        IPQ_DLL_EXPORT int         LoadDatabase(int id, const char* filename);


        IPQ_DLL_EXPORT int         LoadDatabaseString(int id, const char* input);


        IPQ_DLL_EXPORT void        OutputAccumulatedLines(int id);


        IPQ_DLL_EXPORT void        OutputErrorString(int id);


        IPQ_DLL_EXPORT void        OutputWarningString(int id);


        IPQ_DLL_EXPORT int         RunAccumulated(int id);


        IPQ_DLL_EXPORT int         RunFile(int id, const char* filename);


        IPQ_DLL_EXPORT int         RunString(int id, const char* input);

        IPQ_DLL_EXPORT IPQ_RESULT  SetBasicCallback(int id, double (*fcn)(double x1, double x2, const char *str, void *cookie), void *cookie1);

#ifdef IPHREEQC_NO_FORTRAN_MODULE
        IPQ_DLL_EXPORT IPQ_RESULT  SetBasicFortranCallback(int id, double (*fcn)(double *x1, double *x2, char *str, size_t l));
#else
        IPQ_DLL_EXPORT IPQ_RESULT  SetBasicFortranCallback(int id, double (*fcn)(double *x1, double *x2, const char *str, int l));
#endif


        IPQ_DLL_EXPORT IPQ_RESULT  SetCurrentSelectedOutputUserNumber(int id, int n);

        IPQ_DLL_EXPORT IPQ_RESULT  SetDumpFileName(int id, const char* filename);


        IPQ_DLL_EXPORT IPQ_RESULT  SetDumpFileOn(int id, int dump_on);


        IPQ_DLL_EXPORT IPQ_RESULT  SetDumpStringOn(int id, int dump_string_on);

        IPQ_DLL_EXPORT IPQ_RESULT  SetErrorFileName(int id, const char* filename);

        IPQ_DLL_EXPORT IPQ_RESULT  SetErrorFileOn(int id, int error_on);

        IPQ_DLL_EXPORT IPQ_RESULT  SetErrorStringOn(int id, int error_string_on);

        IPQ_DLL_EXPORT IPQ_RESULT  SetLogFileName(int id, const char* filename);

        IPQ_DLL_EXPORT IPQ_RESULT  SetLogFileOn(int id, int log_on);

        IPQ_DLL_EXPORT IPQ_RESULT  SetLogStringOn(int id, int log_string_on);


        IPQ_DLL_EXPORT IPQ_RESULT  SetOutputFileName(int id, const char* filename);

        IPQ_DLL_EXPORT IPQ_RESULT  SetOutputFileOn(int id, int output_on);

        IPQ_DLL_EXPORT IPQ_RESULT  SetOutputStringOn(int id, int output_string_on);


        IPQ_DLL_EXPORT IPQ_RESULT  SetSelectedOutputFileName(int id, const char* filename);


        IPQ_DLL_EXPORT IPQ_RESULT  SetSelectedOutputFileOn(int id, int sel_on);

        IPQ_DLL_EXPORT IPQ_RESULT  SetSelectedOutputStringOn(int id, int sel_string_on);

// TODO int RunWithCallback(PFN_PRERUN_CALLBACK pfn_pre, PFN_POSTRUN_CALLBACK pfn_post, void *cookie, int output_on, int error_on, int log_on, int selected_output_on);


// TODO int CatchErrors(PFN_CATCH_CALLBACK pfn, void *cookie);


#if defined(__cplusplus)
}
#endif

#endif // INC_IPHREEQC_H