[prev in list] [next in list] [prev in thread] [next in thread] 

List:       pear-doc
Subject:    [PEAR-DOC] cvs: peardoc /en/pecl paradox.xml
From:       "Uwe Steinmann" <steinm () php ! net>
Date:       2003-07-29 6:10:48
[Download RAW message or body]

steinm		Tue Jul 29 02:10:48 2003 EDT

  Added files:                 
    /peardoc/en/pecl	paradox.xml 
  Log:
  - initial documentation for paradox extension
  
  

Index: peardoc/en/pecl/paradox.xml
+++ peardoc/en/pecl/paradox.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Author: Uwe Steinmann <steinm@php.net> -->
 <reference id="pecl.paradox">
  <title>Pardox File Access</title>
  <titleabbrev>PARADOX</titleabbrev>
  <partintro>
   <sect1 id="pecl.paradox.partintro">
    <title>Introduction</title>
    <sect2 id="pecl.paradox.intro">
     <title>About Paradox file access</title>
     <para>
      This module allows to read Paradox database and blob files.
     </para>
     <note>
      <para>
       You will need to get the paradox library (libpx) available at
       http://pxlib.sourceforge.net.
      </para>
      <para>
       This module has not been tested on other platforms than Debian/GNU
       Linux for PPC.
      </para>
     </note>
    </sect2>
    <sect2 id="pecl.paradox.install">
     <title>Installation</title>
     <para>
      A short installation note:
      <itemizedlist>
       <listitem>
        <simpara>
         You need at least PHP 4.1.0 and libpx >= 0.0.9
        </simpara>
       </listitem>
       <listitem>
        <simpara>
         Just type 'pear install paradox' in your console.
        </simpara>
       </listitem>
      </itemizedlist>
     </para>
    </sect2>
    <sect2 id="pecl.paradox.configuration">
     <title>Configuration</title>
     <para>
     </para>
    </sect2>
   </sect1>
  </partintro>

  <refentry id="pecl.paradox.px-new">
   <refnamediv>
    <refname>px_new</refname>
    <refpurpose>Create a new paradox object</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>resource <function>px_new</function></funcdef>
	  <paramdef>void <parameter></parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     Create a new paradox object. You will have to call this function
     before any further functions.
    </para>
   </refsect1>
  </refentry>
   <refentry id="pecl.paradox.px-open-fp">
   <refnamediv>
    <refname>px_open_fp</refname>
    <refpurpose>Open paradox database</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>bool <function>px_open_fp</function></funcdef>
	  <paramdef>resource <parameter>pxdoc</parameter></paramdef>
	  <paramdef>resource <parameter>file</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     Open an existing paradox database file. The actual file has to
     be opened before with fopen(). The first parameter is the return
     value of px_new().
    </para>
   </refsect1>
  
  </refentry>
  <refentry id="pecl.paradox.px-close">
   <refnamediv>
    <refname>px_close</refname>
    <refpurpose>Close a paradox database</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>bool <function>px_close</function></funcdef>
	  <paramdef>resource <parameter>pxdoc</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     Close the paradox database.
    </para>
   </refsect1>
  </refentry>
  <refentry id="pecl.paradox.px-delete">
   <refnamediv>
    <refname>px_delete</refname>
    <refpurpose>Deletes resource of paradox database</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>bool <function>px_delete</function></funcdef>
	  <paramdef>resource <parameter>pxdoc</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     Deletes the resource of the paradox file and frees all memory.
    </para>
   </refsect1>
  </refentry>
  <refentry id="pecl.paradox.px-get-record">
   <refnamediv>
    <refname>px_get_record</refname>
    <refpurpose>Returns record in paradox database</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>bool <function>px_delete</function></funcdef>
	  <paramdef>resource <parameter>pxdoc</parameter></paramdef>
	  <paramdef>int <parameter>num</parameter></paramdef>
	  <paramdef>int <parameter><optional>mode</optional></parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     Deletes the resource of the paradox file and frees all memory.
    </para>
   </refsect1>
  </refentry>
  <refentry id="pecl.paradox.px-numrecords">
   <refnamediv>
    <refname>px_numrecords</refname>
    <refpurpose>Returns number of records in a database</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>int <function>px_numrecords</function></funcdef>
	  <paramdef>resource <parameter>pxdoc</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     Returns the number of records in a database file.
    </para>
   </refsect1>
  </refentry>
  <refentry id="pecl.paradox.px-numfields">
   <refnamediv>
    <refname>px_numfields</refname>
    <refpurpose>Returns number of fields in a database</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>int <function>px_numfields</function></funcdef>
	  <paramdef>resource <parameter>pxdoc</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     Returns the number of fields in a database file.
    </para>
   </refsect1>
  </refentry>
  <refentry id="pecl.paradox.px-get-schema">
   <refnamediv>
    <refname>px_get_schema</refname>
    <refpurpose>Returns the database schema</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>array <function>px_get_schema</function></funcdef>
	  <paramdef>resource <parameter>pxdoc</parameter></paramdef>
	  <paramdef>int <parameter><optional>mode</optional></parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     Returns the schema of a database file.
    </para>
   </refsect1>
  </refentry>
  <refentry id="pecl.paradox.px-set-targetencoding">
   <refnamediv>
    <refname>px_set_targetencoding</refname>
    <refpurpose>Sets the encoding of the output</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcprototype>
      <funcdef>bool <function>px_set_targetencoding</function></funcdef>
	  <paramdef>resource <parameter>pxdoc</parameter></paramdef>
	  <paramdef>string <parameter>encoding</parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <para>
     Set the encoding of the output.
    </para>
   </refsect1>
  </refentry>
 </reference>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->



-- 
PEAR Documentation List Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php

[prev in list] [next in list] [prev in thread] [next in thread]