freppleinterface.h File Reference

Public header file for C and C++. More...

#include <string>
Include dependency graph for freppleinterface.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines

#define DECLARE_EXPORT(type)   type

Functions

void FreppleExit ()
void FreppleInitialize ()
void FreppleLog (const std::string &)
void FreppleLog (const char *)
void FreppleReadPythonFile (const char *)
void FreppleReadXMLData (const char *, bool, bool)
void FreppleReadXMLFile (const char *, bool, bool)
void FreppleSaveFile (const char *)
const char * FreppleVersion ()
int FreppleWrapperExit ()
int FreppleWrapperInitialize ()
int FreppleWrapperReadPythonFile (const char *)
int FreppleWrapperReadXMLData (char *, bool, bool)
int FreppleWrapperReadXMLFile (const char *, bool, bool)
int FreppleWrapperSaveFile (char *)

Detailed Description

Public header file for C and C++.

This is the public header file for high-level access to the library functionality.
The methods listed provide also a safe interface API for accessing the library functionality from C, C++, Visual Basic and other programming languages.

When extending the library, use the header file frepple.h instead.
It provides a more detailed API to interface with frePPLe.

Definition in file freppleinterface.h.


Define Documentation

#define DECLARE_EXPORT (   type)    type

Definition at line 67 of file freppleinterface.h.


Function Documentation

void FreppleExit ( )

This function causes the frepple executable to shut down in an orderly way.

This method is synchroneous, i.e. it returns only when the complete processing is finished. The method can throw exceptions, and the client is responsible for defining the correct handlers for these.

Closing any resources still used by frePPle.
Allocated memory is not freed up with this call - for performance reasons it is easier to "leak" the memory. The memory is freed when the process exits.

Definition at line 134 of file dllmain.cpp.

void FreppleInitialize ( )

This function should be called once when the client application starts, and before calling any other function in the API.

This method is synchronous, i.e. it returns only when the complete processing is finished. The method can throw exceptions, and the client is responsible for defining the correct handlers for these.

Definition at line 41 of file dllmain.cpp.

void FreppleLog ( const std::string &  )

Echo a message in the frePPLe log stream (which is either a file or the standard output stream).

This function is only available when using C++. The same functionality is available to C with the function FreppleLog(const char*).

Definition at line 141 of file dllmain.cpp.

void FreppleLog ( const char *  )

Echo a message in the frePPLe log stream (which is either a file or the standard output stream).

Definition at line 147 of file dllmain.cpp.

void FreppleReadPythonFile ( const char *  )

Execute the Python code in a file.

This method is synchroneous, i.e. it returns only when the complete processing is finished. The method can throw exceptions, and the client is responsible for defining the correct handlers for these.

Definition at line 114 of file dllmain.cpp.

void FreppleReadXMLData ( const char *  ,
bool  ,
bool   
)

The character buffer pointed to by the first parameter contains data in XML format that is passed on to frePPLe for processing.
The second argument specifies whether frePPLe should validate the data against the XSD schema.
The last argument specifies whether frePPLe needs to perform only the validation and skip the actual processing.

The client is responsible for the memory management in the data buffer.

This method is synchroneous, i.e. it returns only when the complete processing is finished. The method can throw exceptions, and the client is responsible for defining the correct handlers for these.

Definition at line 83 of file dllmain.cpp.

void FreppleReadXMLFile ( const char *  ,
bool  ,
bool   
)

The first parameter is the name of a file that contains data in XML format for frePPLe processing. If a NULL pointer is passed, frepple will read from the standard input.
The second argument specifies whether frePPLe should validate the data against the XSD schema.
The last argument specifies whether frePPLe needs to perform only the validation and skip the actual processing.

This method is synchroneous, i.e. it returns only when the complete processing is finished. The method can throw exceptions, and the client is responsible for defining the correct handlers for these.

Definition at line 93 of file dllmain.cpp.

void FreppleSaveFile ( const char *  )

Calling this function will save the frePPLe data in the file that is passed as the argument.

This method is synchroneous, i.e. it returns only when the complete processing is finished. The method can throw exceptions, and the client is responsible for defining the correct handlers for these.

Definition at line 122 of file dllmain.cpp.

const char* FreppleVersion ( )

This method returns a version string.

Definition at line 35 of file dllmain.cpp.

int FreppleWrapperExit ( )

Same as FreppleExit, but catches all exceptions and returns a status instead.

Use this function when calling the library from C or VB applications.

See also:
FreppleExit

Definition at line 193 of file dllmain.cpp.

int FreppleWrapperInitialize ( )

Same as FreppleInitialize, but catches all exceptions and returns a status instead.

Use this function when calling the library from C or VB applications.

See also:
FreppleInitialize

Definition at line 153 of file dllmain.cpp.

int FreppleWrapperReadPythonFile ( const char *  )

Same as FreppleReadPythonFile, but catches all exceptions and returns a status instead.

Use this function when calling the library from C or VB applications.

See also:
FreppleReadPythonFile

Definition at line 177 of file dllmain.cpp.

int FreppleWrapperReadXMLData ( char *  ,
bool  ,
bool   
)

Same as FreppleReadXMLData, but catches all exceptions and returns a status instead.

Use this function when calling the library from C or VB applications.

See also:
FreppleReadXMLData

Definition at line 161 of file dllmain.cpp.

int FreppleWrapperReadXMLFile ( const char *  ,
bool  ,
bool   
)

Same as FreppleReadXMLFile, but catches all exceptions and returns a status instead.

Use this function when calling the library from C or VB applications.

See also:
FreppleReadXMLFile

Definition at line 169 of file dllmain.cpp.

int FreppleWrapperSaveFile ( char *  )

Same as FreppleSaveFile, but catches all exceptions and returns a status instead.

Use this function when calling the library from C or VB applications.

See also:
FreppleSaveFile

Definition at line 185 of file dllmain.cpp.


Documentation generated for frePPLe by  doxygen