<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>CapiSuite: capisuitemodule.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.8 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
<h1>capisuitemodule.h File Reference</h1>Contains the Python module integration routines. <a href="#_details">More...</a>
<p>
<code>#include <Python.h></code><br>
<code>#include "<a class="el" href="applicationexception_8h-source.html">applicationexception.h</a>"</code><br>
<p>
<a href="capisuitemodule_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="capisuitemodule_8h.html#a0">capisuitemodule_init</a> () throw (ApplicationError)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes and registers C implementation of python module capisuite. <a href="#a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="capisuitemodule_8h.html#a1">capisuitemodule_destruct_connection</a> (void *conn)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor function for <a class="el" href="classConnection.html">Connection</a> reference given to Python scripts. <a href="#a1"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Contains the Python module integration routines.
<p>
This file contains the implementation of thy python module capisuite which contains all commands available in python scripts for programming capisuite.<p>
There are two groups of functions: functions used from C++ to init and access the python module and functions used from python implementing the functions of the python module.<p>
Here you'll only find the functions used from C++. If you're interested in the commands usable from python, please have a look at the documentation found in <a class="el" href="group__python.html">C/Python wrapper functions</a>.<p>
<dl compact><dt><b>Author:</b></dt><dd>Gernot Hillier <<a href="mailto:gernot@hillier.de">gernot@hillier.de</a>> <dl compact><dt><b>Revision</b></dt><dd>1.2 </dd></dl>
</dd></dl>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="a1" doxytag="capisuitemodule.h::capisuitemodule_destruct_connection" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void capisuitemodule_destruct_connection </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void * </td>
<td class="mdname1" valign="top" nowrap> <em>conn</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Destructor function for <a class="el" href="classConnection.html">Connection</a> reference given to Python scripts.
<p>
This function will be called by Python if the given connection reference is not used any more in the script. This will lead to the destruction of the <a class="el" href="classConnection.html">Connection</a> object.<p>
This function has the right signature to pass as destructor function for PyCCobject_FromVoidPtr() calls.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>conn</em> </td><td><a class="el" href="classConnection.html">Connection</a> reference </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a0" doxytag="capisuitemodule.h::capisuitemodule_init" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void capisuitemodule_init </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> throw (<a class="el" href="classApplicationError.html">ApplicationError</a>)</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Initializes and registers C implementation of python module capisuite.
<p>
This function creates a new python module named "capisuite" containing the functions for the control of capisuite and two exception types: CallGoneError and BackendError (see <a class="el" href="group__python.html">C/Python wrapper functions</a>). Also there are three constants defined: SERVICE_VOICE, SERVICE_FAXG3, SERVICE_OTHER, see also <a class="el" href="classConnection.html#w10">Connection::service_t</a>.<p>
<dl compact><dt><b>Returns:</b></dt><dd><b>borrowed</b> reference to the __main__-Dictionary of the created python interpreter </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>ApplicationError</em> </td><td>Thrown if some step of the module initialization fails. See errormsg for details. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 28 14:37:44 2004 for CapiSuite by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
06e1e0ab98898582c876a8be34ecb5e9
>
files
>
188
