From d8d47251a0c73269c320e2fec10faad20f4a731d Mon Sep 17 00:00:00 2001
From: Gabor Hojtsy <goba@php.net>
Date: Sat, 20 Jul 2002 13:49:26 +0000
Subject: [PATCH] Adding documentation from php4/ext/w32api/README and the
 updated example from the examples dir. Using the new structure, moving
 constants here...

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@89192 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/w32api/constants.xml | 136 +++++++++++++++++++++++++++++++++
 reference/w32api/reference.xml |  70 ++++++++++++++++-
 2 files changed, 202 insertions(+), 4 deletions(-)
 create mode 100644 reference/w32api/constants.xml

diff --git a/reference/w32api/constants.xml b/reference/w32api/constants.xml
new file mode 100644
index 0000000000..c9681093da
--- /dev/null
+++ b/reference/w32api/constants.xml
@@ -0,0 +1,136 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<section id="w32api.constants">
+ &reftitle.constants;
+ &extension.constants;
+ <variablelist>
+  <varlistentry>
+   <term>
+    <constant>DC_MICROSOFT</constant> 
+    (<link linkend="language.types.integer">integer</link>)
+   </term>
+   <listitem>
+    <simpara>
+     
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>
+    <constant>DC_BORLAND</constant> 
+    (<link linkend="language.types.integer">integer</link>)
+   </term>
+   <listitem>
+    <simpara>
+     
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>
+    <constant>DC_CALL_CDECL</constant> 
+    (<link linkend="language.types.integer">integer</link>)
+   </term>
+   <listitem>
+    <simpara>
+     
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>
+    <constant>DC_CALL_STD</constant> 
+    (<link linkend="language.types.integer">integer</link>)
+   </term>
+   <listitem>
+    <simpara>
+     
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>
+    <constant>DC_RETVAL_MATH4</constant> 
+    (<link linkend="language.types.integer">integer</link>)
+   </term>
+   <listitem>
+    <simpara>
+     
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>
+    <constant>DC_RETVAL_MATH8</constant> 
+    (<link linkend="language.types.integer">integer</link>)
+   </term>
+   <listitem>
+    <simpara>
+     
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>
+    <constant>DC_CALL_STD_BO</constant> 
+    (<link linkend="language.types.integer">integer</link>)
+   </term>
+   <listitem>
+    <simpara>
+     
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>
+    <constant>DC_CALL_STD_MS</constant> 
+    (<link linkend="language.types.integer">integer</link>)
+   </term>
+   <listitem>
+    <simpara>
+     
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>
+    <constant>DC_CALL_STD_M8</constant> 
+    (<link linkend="language.types.integer">integer</link>)
+   </term>
+   <listitem>
+    <simpara>
+     
+    </simpara>
+   </listitem>
+  </varlistentry>
+  <varlistentry>
+   <term>
+    <constant>DC_FLAG_ARGPTR</constant> 
+    (<link linkend="language.types.integer">integer</link>)
+   </term>
+   <listitem>
+    <simpara>
+     
+    </simpara>
+   </listitem>
+  </varlistentry>
+ </variablelist>
+</section>
+
+<!-- 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
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+-->
diff --git a/reference/w32api/reference.xml b/reference/w32api/reference.xml
index 346d2c2141..23d8b05afb 100644
--- a/reference/w32api/reference.xml
+++ b/reference/w32api/reference.xml
@@ -1,12 +1,74 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
  <reference id="ref.w32api">
   <title>W32api functions</title>
-  <titleabbrev>W32api functions</titleabbrev>
+  <titleabbrev>W32api</titleabbrev>
 
   <partintro>
-   <para>
-   </para>
+   <section id="w32api.intro">
+    &reftitle.intro;
+    <para>
+     This extension is a generic extension api to DLLs. This was originally
+     written to allow access to the Win32 API from PHP. Although you can also
+     access other functions exported via other DLLs.
+    </para>
+    <para>
+     Currently supported types are generic PHP types (strings, bools, doubles,
+     longs and null's) others will be added in the future.
+    </para>
+   </section>
+   
+   &reference.w32api.constants;
+   
+   <section id="w32api.examples">
+    &reftitle.examples;
+    <para>
+     This example gets the amount of time the system has been running and
+     displays it in a message box.
+    </para>
+    <example>
+     <title>Get the uptime and display in a message box</title>
+     <programlisting role="php">
+<![CDATA[
+<?php
+// Define constants needed, taken from
+// Visual Studio/Tools/Winapi/WIN32API.txt
+define("MB_OK", 0);
+
+dl("php_w32api.dll");
+
+w32api_register_function("kernel32.dll", 
+                         "GetTickCount",
+                         "long");
+                         
+w32api_register_function("User32.dll",
+                         "MessageBoxA",
+                         "long");
+
+$ticks = GetTickCount();
+
+$secs = floor($ticks / 1000);
+$mins = floor($secs / 60);
+$hours = floor($mins / 60);
+
+$str = sprintf("You have been using your computer for:".
+                "\r\n %d Milliseconds, or \r\n %d Seconds".
+                "or \r\n %d mins or\r\n %d hours %d mins.",
+                $ticks,
+                $secs,
+                $mins,
+                $hours,
+                $mins - ($hours*60));
+
+MessageBoxA(NULL, 
+            $str, 
+            "Uptime Information", 
+            MB_OK);
+?>
+]]>
+     </programlisting>
+    </example>
+   </section>
   </partintro>
 
 &reference.w32api.functions;