php-doc-en/reference/com/functions/class.variant.xml
Friedhelm Betz 6b59db7ea1 acronym tagging for MSDN
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@135018 c90b9560-bf6c-de11-be94-00142212c4b1
2003-07-14 09:10:17 +00:00

87 lines
3.3 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/com.xml, last change in rev 1.7 -->
<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>
<methodsynopsis>
<type>string</type><methodname>VARIANT::VARIANT</methodname>
<methodparam choice="opt"><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>codepage</parameter></methodparam>
</methodsynopsis>
<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 being a value. If omitted,
the type of <parameter>value</parameter> is used. Consult the <acronym>MSDN</acronym> 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>
<!-- 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:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->