<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>C++ API frePPLe: freppleinterface.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="../styles.css" rel="stylesheet" type="text/css">
</head>
<body>
<div id="container">
<div id="menubar">
<div id="logo" align="center">
<br/><img src='../frepple.bmp' alt="frepple" /><br/>
<a href='http://www.frepple.com/'>
<strong>a Free<br/>Production Planning<br/>Library</strong>
</a>
</div>
<div id="menu">
<br/>
<h3><a href='../Main/HomePage.html'>Main</a></h3>
<h3><a href='../UI/Main.html'>User Manual</a></h3>
<h3><a href='../Tutorial/Main.html'>Tutorial</a></h3>
<h3><a href='../Frepple/Main.html'>Reference Manual</a></h3>
<h3><a href='../Main/FAQ.html'>FAQ</a></h3>
<h3><a href='index.html'>C++ API</a></h3>
<br/>
</div>
</div>
<div id="content">
<br/>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_18992602582d7248789456d5a25e14d1.html">include</a>
</div>
</div>
<div class="contents">
<h1>freppleinterface.h File Reference</h1>
<p>Public header file for C and C++.
<a href="#_details">More...</a></p>
<code>#include <string></code><br/>
<div class="dynheader">
Include dependency graph for freppleinterface.h:</div>
<div class="dynsection">
<div class="center"><img src="a00280.png" border="0" usemap="#freppleinterface_8h_map" alt=""/></div>
</div>
<div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dynsection">
<div class="center"><img src="a00281.png" border="0" usemap="#freppleinterface_8hdep_map" alt=""/></div>
<map name="freppleinterface_8hdep_map" id="freppleinterface_8hdep">
<area shape="rect" id="node3" href="a00200.html" title="dllmain.cpp" alt="" coords="5,83,93,111"/>
<area shape="rect" id="node5" href="a00217.html" title="main.cpp" alt="" coords="117,83,192,111"/>
<area shape="rect" id="node7" href="a00221.html" title="Header file for the module webservice." alt="" coords="216,83,291,111"/>
<area shape="rect" id="node9" href="a00220.html" title="module.cpp" alt="" coords="101,161,189,189"/>
<area shape="rect" id="node11" href="a00236.html" title="server.cpp" alt="" coords="213,161,293,189"/>
<area shape="rect" id="node13" href="a00253.html" title="webservice.cpp" alt="" coords="317,161,427,189"/>
</map>
</div>
<p><a href="a00207_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00207.html#ac41fc23b6047e1aec0a8626104711eb0">DECLARE_EXPORT</a>(type) type</td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00207.html#a343ef9b72a0d751e081c33e680cf53ac">FreppleExit</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00207.html#a13335a18ae6783b5c2aa79a73c0947f9">FreppleInitialize</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00207.html#a0e7b2ba82edeeb9e457e0c792c56f36d">FreppleLog</a> (const char *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00207.html#a646e2a594a659e0388e4e16260ad4c12">FreppleLog</a> (const std::string &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00207.html#a3fc208638127f40dfaec2fd24984925e">FreppleReadXMLData</a> (const char *, bool, bool)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00207.html#a6a4fbbd910c5658eedfcb7afdc6afba9">FreppleReadXMLFile</a> (const char *, bool, bool)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00207.html#a3f0d1ee84b42c07bdd98c4305682da2d">FreppleSaveFile</a> (const char *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00207.html#a597067b13c71006d886fb8c124a1d003">FreppleVersion</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00207.html#abfef211e8bc738a30a69e5584573182e">FreppleWrapperExit</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00207.html#aa09bdb80ef8c0b142611cfa6f480e5e2">FreppleWrapperInitialize</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00207.html#acd3b85ebffd167d066bca0876156b576">FreppleWrapperReadXMLData</a> (char *, bool, bool)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00207.html#a121d614a823d805d5bf6fce3d321375c">FreppleWrapperReadXMLFile</a> (const char *, bool, bool)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00207.html#ab11e4ac6a671f0b7a34c1a177e45689e">FreppleWrapperSaveFile</a> (char *)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Public header file for C and C++. </p>
<p>This is the public header file for high-level access to the library functionality.<br/>
The methods listed provide also a safe interface API for accessing the library functionality from C, C++, Visual Basic and other programming languages.</p>
<p>When extending the library, use the header file <a class="el" href="a00206.html" title="Public header file for C++.">frepple.h</a> instead.<br/>
It provides a more detailed API to interface with frePPLe. </p>
<p>Definition in file <a class="el" href="a00207_source.html">freppleinterface.h</a>.</p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ac41fc23b6047e1aec0a8626104711eb0"></a><!-- doxytag: member="freppleinterface.h::DECLARE_EXPORT" ref="ac41fc23b6047e1aec0a8626104711eb0" args="(type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DECLARE_EXPORT</td>
<td>(</td>
<td class="paramtype">type </td>
<td class="paramname"></td>
<td> ) </td>
<td> type</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00207_source.html#l00067">67</a> of file <a class="el" href="a00207_source.html">freppleinterface.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a343ef9b72a0d751e081c33e680cf53ac"></a><!-- doxytag: member="freppleinterface.h::FreppleExit" ref="a343ef9b72a0d751e081c33e680cf53ac" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FreppleExit </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function causes the <a class="el" href="a00256.html" title="Core namespace.">frepple</a> executable to shut down in an orderly way.</p>
<p>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.</p>
<p>Closing any resources still used by frePPle.<br/>
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. </p>
<p>Definition at line <a class="el" href="a00200_source.html#l00108">108</a> of file <a class="el" href="a00200_source.html">dllmain.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a13335a18ae6783b5c2aa79a73c0947f9"></a><!-- doxytag: member="freppleinterface.h::FreppleInitialize" ref="a13335a18ae6783b5c2aa79a73c0947f9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FreppleInitialize </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function should be called once when the client application starts, and before calling any other function in the API.</p>
<p>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. </p>
<p>Definition at line <a class="el" href="a00200_source.html#l00041">41</a> of file <a class="el" href="a00200_source.html">dllmain.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0e7b2ba82edeeb9e457e0c792c56f36d"></a><!-- doxytag: member="freppleinterface.h::FreppleLog" ref="a0e7b2ba82edeeb9e457e0c792c56f36d" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FreppleLog </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Echo a message in the frePPLe log stream (which is either a file or the standard output stream). </p>
<p>Definition at line <a class="el" href="a00200_source.html#l00121">121</a> of file <a class="el" href="a00200_source.html">dllmain.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a646e2a594a659e0388e4e16260ad4c12"></a><!-- doxytag: member="freppleinterface.h::FreppleLog" ref="a646e2a594a659e0388e4e16260ad4c12" args="(const std::string &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FreppleLog </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Echo a message in the frePPLe log stream (which is either a file or the standard output stream).</p>
<p>This function is only available when using C++. The same functionality is available to C with the function <a class="el" href="a00207.html#a0e7b2ba82edeeb9e457e0c792c56f36d">FreppleLog(const char*)</a>. </p>
<p>Definition at line <a class="el" href="a00200_source.html#l00115">115</a> of file <a class="el" href="a00200_source.html">dllmain.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3fc208638127f40dfaec2fd24984925e"></a><!-- doxytag: member="freppleinterface.h::FreppleReadXMLData" ref="a3fc208638127f40dfaec2fd24984925e" args="(const char *, bool, bool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FreppleReadXMLData </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The character buffer pointed to by the first parameter contains data in XML format that is passed on to frePPLe for processing.<br/>
The second argument specifies whether frePPLe should validate the data against the XSD schema.<br/>
The last argument specifies whether frePPLe needs to perform only the validation and skip the actual processing.</p>
<p>The client is responsible for the memory management in the data buffer.</p>
<p>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. </p>
<p>Definition at line <a class="el" href="a00200_source.html#l00085">85</a> of file <a class="el" href="a00200_source.html">dllmain.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6a4fbbd910c5658eedfcb7afdc6afba9"></a><!-- doxytag: member="freppleinterface.h::FreppleReadXMLFile" ref="a6a4fbbd910c5658eedfcb7afdc6afba9" args="(const char *, bool, bool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FreppleReadXMLFile </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The first parameter is the name of a file that contains data in XML format for frePPLe processing. If a NULL pointer is passed, <a class="el" href="a00256.html" title="Core namespace.">frepple</a> will read from the standard input.<br/>
The second argument specifies whether frePPLe should validate the data against the XSD schema.<br/>
The last argument specifies whether frePPLe needs to perform only the validation and skip the actual processing.</p>
<p>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. </p>
<p>Definition at line <a class="el" href="a00200_source.html#l00091">91</a> of file <a class="el" href="a00200_source.html">dllmain.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3f0d1ee84b42c07bdd98c4305682da2d"></a><!-- doxytag: member="freppleinterface.h::FreppleSaveFile" ref="a3f0d1ee84b42c07bdd98c4305682da2d" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FreppleSaveFile </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Calling this function will save the frePPLe data in the file that is passed as the argument.</p>
<p>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. </p>
<p>Definition at line <a class="el" href="a00200_source.html#l00097">97</a> of file <a class="el" href="a00200_source.html">dllmain.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a597067b13c71006d886fb8c124a1d003"></a><!-- doxytag: member="freppleinterface.h::FreppleVersion" ref="a597067b13c71006d886fb8c124a1d003" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* FreppleVersion </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method returns a version string. </p>
<p>Definition at line <a class="el" href="a00200_source.html#l00035">35</a> of file <a class="el" href="a00200_source.html">dllmain.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="abfef211e8bc738a30a69e5584573182e"></a><!-- doxytag: member="freppleinterface.h::FreppleWrapperExit" ref="abfef211e8bc738a30a69e5584573182e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FreppleWrapperExit </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Same as FreppleExit, but catches all exceptions and returns a status instead.</p>
<p>Use this function when calling the library from C or VB applications. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00207.html#a343ef9b72a0d751e081c33e680cf53ac">FreppleExit</a> </dd></dl>
<p>Definition at line <a class="el" href="a00200_source.html#l00159">159</a> of file <a class="el" href="a00200_source.html">dllmain.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa09bdb80ef8c0b142611cfa6f480e5e2"></a><!-- doxytag: member="freppleinterface.h::FreppleWrapperInitialize" ref="aa09bdb80ef8c0b142611cfa6f480e5e2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FreppleWrapperInitialize </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Same as FreppleInitialize, but catches all exceptions and returns a status instead.</p>
<p>Use this function when calling the library from C or VB applications. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00207.html#a13335a18ae6783b5c2aa79a73c0947f9">FreppleInitialize</a> </dd></dl>
<p>Definition at line <a class="el" href="a00200_source.html#l00127">127</a> of file <a class="el" href="a00200_source.html">dllmain.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="acd3b85ebffd167d066bca0876156b576"></a><!-- doxytag: member="freppleinterface.h::FreppleWrapperReadXMLData" ref="acd3b85ebffd167d066bca0876156b576" args="(char *, bool, bool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FreppleWrapperReadXMLData </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Same as FreppleReadXMLData, but catches all exceptions and returns a status instead.</p>
<p>Use this function when calling the library from C or VB applications. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00207.html#a3fc208638127f40dfaec2fd24984925e">FreppleReadXMLData</a> </dd></dl>
<p>Definition at line <a class="el" href="a00200_source.html#l00135">135</a> of file <a class="el" href="a00200_source.html">dllmain.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a121d614a823d805d5bf6fce3d321375c"></a><!-- doxytag: member="freppleinterface.h::FreppleWrapperReadXMLFile" ref="a121d614a823d805d5bf6fce3d321375c" args="(const char *, bool, bool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FreppleWrapperReadXMLFile </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Same as FreppleReadXMLFile, but catches all exceptions and returns a status instead.</p>
<p>Use this function when calling the library from C or VB applications. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00207.html#a6a4fbbd910c5658eedfcb7afdc6afba9">FreppleReadXMLFile</a> </dd></dl>
<p>Definition at line <a class="el" href="a00200_source.html#l00143">143</a> of file <a class="el" href="a00200_source.html">dllmain.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab11e4ac6a671f0b7a34c1a177e45689e"></a><!-- doxytag: member="freppleinterface.h::FreppleWrapperSaveFile" ref="ab11e4ac6a671f0b7a34c1a177e45689e" args="(char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FreppleWrapperSaveFile </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Same as FreppleSaveFile, but catches all exceptions and returns a status instead.</p>
<p>Use this function when calling the library from C or VB applications. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00207.html#a3f0d1ee84b42c07bdd98c4305682da2d">FreppleSaveFile</a> </dd></dl>
<p>Definition at line <a class="el" href="a00200_source.html#l00151">151</a> of file <a class="el" href="a00200_source.html">dllmain.cpp</a>.</p>
</div>
</div>
</div>
<hr size="1"/><address style="align: right;"><small>Documentation generated for frePPLe by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"/></a></small></address>
</div>
</div>
</body>
</html>
