sam-t2/devtools/amd64/html/python/api/api.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="api.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="api.html" title='Python/C API Reference Manual' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="front.html" />
<meta name='aesop' content='information' />
<title>Python/C API Reference Manual</title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></td>
<td class='online-navigation'><a rel="parent" title="Python Documentation Index"
  href="../index.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="Front Matter"
  href="front.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python/C API Reference Manual</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="../index.html">Python Documentation Index</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="front.html">Front Matter</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<P>

<link rel='up' href='../index.html' title='Python Documentation Index' />
<div class="titlepage">
<div class='center'>
<h1>Python/C API Reference Manual</h1>
<p><b><font size="+2">Guido van Rossum</font></b></p>
<p>
        <strong>Python Software Foundation</strong>
<BR>
Email: <span class="email">docs@python.org</span>
</p>
<p><i>  Fred L. Drake, Jr., editor</i></p>
<p><strong>Release 2.4.2</strong><br />
<strong>28 September 2005</strong></p>
<p></p>
</div>
</div>

<P>

<p><br /></p><hr class='online-navigation' />
<div class='online-navigation'>
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"></a>

<UL CLASS="ChildLinks">
<LI><A href="front.html">Front Matter</a>
<LI><A href="contents.html">Contents</a>
<LI><A href="intro.html">1. Introduction</a>
<UL>
<LI><A href="includes.html">1.1 Include Files</a>
<LI><A href="objects.html">1.2 Objects, Types and Reference Counts</a>
<UL>
<LI><A href="refcounts.html">1.2.1 Reference Counts</a>
<LI><A href="types.html">1.2.2 Types</a>
</ul>
<LI><A href="exceptions.html">1.3 Exceptions</a>
<LI><A href="embedding.html">1.4 Embedding Python</a>
</ul>
<LI><A href="veryhigh.html">2. The Very High Level Layer</a>
<LI><A href="countingRefs.html">3. Reference Counting</a>
<LI><A href="exceptionHandling.html">4. Exception Handling</a>
<UL>
<LI><A href="standardExceptions.html">4.1 Standard Exceptions</a>
<LI><A href="node15.html">4.2 Deprecation of String Exceptions</a>
</ul>
<LI><A href="utilities.html">5. Utilities</a>
<UL>
<LI><A href="os.html">5.1 Operating System Utilities</a>
<LI><A href="processControl.html">5.2 Process Control</a>
<LI><A href="importing.html">5.3 Importing Modules</a>
<LI><A href="marshalling-utils.html">5.4 Data marshalling support</a>
<LI><A href="arg-parsing.html">5.5 Parsing arguments and building values</a>
</ul>
<LI><A href="abstract.html">6. Abstract Objects Layer</a>
<UL>
<LI><A href="object.html">6.1 Object Protocol</a>
<LI><A href="number.html">6.2 Number Protocol</a>
<LI><A href="sequence.html">6.3 Sequence Protocol</a>
<LI><A href="mapping.html">6.4 Mapping Protocol</a>
<LI><A href="iterator.html">6.5 Iterator Protocol</a>
<LI><A href="abstract-buffer.html">6.6 Buffer Protocol</a>
</ul>
<LI><A href="concrete.html">7. Concrete Objects Layer</a>
<UL>
<LI><A href="fundamental.html">7.1 Fundamental Objects</a>
<UL>
<LI><A href="typeObjects.html">7.1.1 Type Objects</a>
<LI><A href="noneObject.html">7.1.2 The None Object</a>
</ul>
<LI><A href="numericObjects.html">7.2 Numeric Objects</a>
<UL>
<LI><A href="intObjects.html">7.2.1 Plain Integer Objects</a>
<LI><A href="boolObjects.html">7.2.2 Boolean Objects</a>
<LI><A href="longObjects.html">7.2.3 Long Integer Objects</a>
<LI><A href="floatObjects.html">7.2.4 Floating Point Objects</a>
<LI><A href="complexObjects.html">7.2.5 Complex Number Objects</a>
</ul>
<LI><A href="sequenceObjects.html">7.3 Sequence Objects</a>
<UL>
<LI><A href="stringObjects.html">7.3.1 String Objects</a>
<LI><A href="unicodeObjects.html">7.3.2 Unicode Objects</a>
<LI><A href="bufferObjects.html">7.3.3 Buffer Objects</a>
<LI><A href="tupleObjects.html">7.3.4 Tuple Objects</a>
<LI><A href="listObjects.html">7.3.5 List Objects</a>
</ul>
<LI><A href="mapObjects.html">7.4 Mapping Objects</a>
<UL>
<LI><A href="dictObjects.html">7.4.1 Dictionary Objects</a>
</ul>
<LI><A href="otherObjects.html">7.5 Other Objects</a>
<UL>
<LI><A href="fileObjects.html">7.5.1 File Objects</a>
<LI><A href="instanceObjects.html">7.5.2 Instance Objects</a>
<LI><A href="method-objects.html">7.5.3 Method Objects</a>
<LI><A href="moduleObjects.html">7.5.4 Module Objects</a>
<LI><A href="iterator-objects.html">7.5.5 Iterator Objects</a>
<LI><A href="descriptor-objects.html">7.5.6 Descriptor Objects</a>
<LI><A href="slice-objects.html">7.5.7 Slice Objects</a>
<LI><A href="weakref-objects.html">7.5.8 Weak Reference Objects</a>
<LI><A href="cObjects.html">7.5.9 CObjects</a>
<LI><A href="cell-objects.html">7.5.10 Cell Objects</a>
<LI><A href="gen-objects.html">7.5.11 Generator Objects</a>
<LI><A href="datetime-objects.html">7.5.12 DateTime Objects</a>
</ul>
</ul>
<LI><A href="initialization.html">8. Initialization, Finalization, and Threads</a>
<UL>
<LI><A href="threads.html">8.1 Thread State and the Global Interpreter Lock</a>
<LI><A href="profiling.html">8.2 Profiling and Tracing</a>
<LI><A href="advanced-debugging.html">8.3 Advanced Debugger Support</a>
</ul>
<LI><A href="memory.html">9. Memory Management</a>
<UL>
<LI><A href="memoryOverview.html">9.1 Overview</a>
<LI><A href="memoryInterface.html">9.2 Memory Interface</a>
<LI><A href="memoryExamples.html">9.3 Examples</a>
</ul>
<LI><A href="newTypes.html">10. Object Implementation Support</a>
<UL>
<LI><A href="allocating-objects.html">10.1 Allocating Objects on the Heap</a>
<LI><A href="common-structs.html">10.2 Common Object Structures</a>
<LI><A href="type-structs.html">10.3 Type Objects</a>
<LI><A href="mapping-structs.html">10.4 Mapping Object Structures</a>
<LI><A href="number-structs.html">10.5 Number Object Structures</a>
<LI><A href="sequence-structs.html">10.6 Sequence Object Structures</a>
<LI><A href="buffer-structs.html">10.7 Buffer Object Structures</a>
<LI><A href="supporting-iteration.html">10.8 Supporting the Iterator Protocol</a>
<LI><A href="supporting-cycle-detection.html">10.9 Supporting Cyclic Garbage Collection</a>
</ul>
<LI><A href="reporting-bugs.html">A. Reporting Bugs</a>
<LI><A href="node83.html">B. History and License</a>
<UL>
<LI><A href="node84.html">B.1 History of the software</a>
<LI><A href="node85.html">B.2 Terms and conditions for accessing or otherwise using Python</a>
<LI><A href="node86.html">B.3 Licenses and Acknowledgements for Incorporated Software</a>
<UL>
<LI><A href="node87.html">B.3.1 Mersenne Twister</a>
<LI><A href="node88.html">B.3.2 Sockets</a>
<LI><A href="node89.html">B.3.3 Floating point exception control</a>
<LI><A href="node90.html">B.3.4 MD5 message digest algorithm</a>
<LI><A href="node91.html">B.3.5 Asynchronous socket services</a>
<LI><A href="node92.html">B.3.6 Cookie management</a>
<LI><A href="node93.html">B.3.7 Profiling</a>
<LI><A href="node94.html">B.3.8 Execution tracing</a>
<LI><A href="node95.html">B.3.9 UUencode and UUdecode functions</a>
<LI><A href="node96.html">B.3.10 XML Remote Procedure Calls</a>
</ul>
</ul>
<LI><A href="genindex.html">Index</a>
<LI><A href="about.html">About this document ...</a>
</ul>
<!--End of Table of Child-Links-->
</div>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></td>
<td class='online-navigation'><a rel="parent" title="Python Documentation Index"
  href="../index.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="Front Matter"
  href="front.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python/C API Reference Manual</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="../index.html">Python Documentation Index</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="front.html">Front Matter</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>