From 8f16cc3ca648872d4f913e754e1025fb6ee79806 Mon Sep 17 00:00:00 2001
From: Harald Radi <phanto@php.net>
Date: Fri, 18 May 2001 15:04:09 +0000
Subject: [PATCH] added VARIANT section

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@47771 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/com.xml | 69 ++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 68 insertions(+), 1 deletion(-)

diff --git a/functions/com.xml b/functions/com.xml
index 1eb2d13b69..28bc2b3a61 100644
--- a/functions/com.xml
+++ b/functions/com.xml
@@ -100,7 +100,8 @@ $word = null;
      <title>COM example (2)</title>
      <programlisting role="php">
 $conn = new COM("ADODB.Connection") or die("Cannot start ADO");
-$conn->Open("Provider=SQLOLEDB; Data Source=localhost; Initial Catalog=database; User ID=user; Password=password");
+$conn->Open("Provider=SQLOLEDB; Data Source=localhost;
+Initial Catalog=database; User ID=user; Password=password");
 
 $rs = $conn->Execute("SELECT * FROM sometable");    // Recordset
 
@@ -138,6 +139,72 @@ $conn = null;
   </refsect1>
  </refentry>
  
+ <refentry id="class.variant">
+  <refnamediv>
+   <refname>VARIANT</refname>
+   <refpurpose>VARIANT class</refpurpose>
+  </refnamediv>
+  <refsynopsisdiv>
+  <synopsis>$vVar = new <classname>VARIANT</classname>($var)</synopsis>
+  </refsynopsisdiv>
+  <refsect1 id="class.variant.class">
+   <title>Description</title>
+   <simpara>
+    A simple container to wrap variables into VARIANT structures.
+   </simpara>
+  </refsect1>
+  <refsect1 id="class.variant.constructor">
+   <title>Methods</title>
+   <funcsynopsis>
+    <funcprototype>
+     <funcdef>string <function>VARIANT::VARIANT</function></funcdef>
+     <paramdef>mixed <parameter><optional>value/optional></parameter></paramdef>
+     <paramdef>int <parameter><optional>type</optional></parameter></paramdef>
+     <paramdef>int <parameter><optional>codepage</optional></parameter></paramdef>
+    </funcprototype>
+   </funcsynopsis>
+   <para>
+    VARIANT class constructor. Parameters:
+    <variablelist>
+    <varlistentry><term>value</term>
+    <listitem>
+     <simpara>
+      initial value. if omitted an VT_EMPTY object is created.
+     </simpara>
+    </listitem>
+    </varlistentry>
+    <varlistentry><term>type</term>
+    <listitem>
+     <simpara>
+      specifies the content type of the VARIANT object. Possible values are
+      <constant>VT_UI1</constant>, <constant>VT_UI2</constant>, <constant>VT_UI4</constant>, 
+      <constant>VT_I1</constant>, <constant>VT_I2</constant>, <constant>VT_I4</constant>, 
+      <constant>VT_R4</constant>, <constant>VT_R8</constant>, <constant>VT_INT</constant>, <constant>VT_UINT</constant>,
+      <constant>VT_BOOL</constant>, <constant>VT_ERROR</constant>, <constant>VT_CY</constant>, 
+      <constant>VT_DATE</constant>, <constant>VT_BSTR</constant>, <constant>VT_DECIMAL</constant>, 
+      <constant>VT_UNKNOWN</constant>, <constant>VT_DISPATCH</constant> and <constant>VT_VARIANT</constant>. These values are
+      mutual exclusive, but they can be combined with <constant>VT_BYREF</constant> to specify beeing a value. If omitted,
+      the type of <parameter>value</parameter> is used. Consult the msdn library for additional information.
+     </simpara>
+    </listitem>
+    </varlistentry>
+    <varlistentry><term>codepage</term>
+    <listitem>
+     <simpara>
+      specifies the codepage that is used to convert php-strings to
+      unicode-strings and vice versa. Possible values are
+      <constant>CP_ACP</constant>, <constant>CP_MACCP</constant>,
+      <constant>CP_OEMCP</constant>, <constant>CP_SYMBOL</constant>,
+      <constant>CP_THREAD_ACP</constant>, <constant>CP_UTF7</constant>
+      and <constant>CP_UTF8</constant>.
+     </simpara>
+    </listitem>
+    </varlistentry>
+    </variablelist>
+   </para>
+  </refsect1>
+ </refentry>
+ 
  <refentry id="function.com-load">
   <refnamediv>
    <refname>com_load</refname>