php-doc-en/reference/com/variant/construct.xml
Christoph Michael Becker b6de362f1c Document parameter defaults
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347692 c90b9560-bf6c-de11-be94-00142212c4b1
2019-06-30 13:50:15 +00:00

86 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="variant.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>VARIANT::__construct</refname>
<refpurpose>VARIANT class constructor</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<constructorsynopsis role="oop">
<methodname>VARIANT::__construct</methodname>
<methodparam choice="opt"><type>mixed</type><parameter>value</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>type</parameter><initializer>VT_EMPTY</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>codepage</parameter><initializer>CP_ACP</initializer></methodparam>
</constructorsynopsis>
<para>
Constructs a new VARIANT object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<simpara>
Initial value. If omitted, or set to &null; an VT_EMPTY object is created.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<simpara>
Specifies the content type of the VARIANT object. Possible values are
one of the <constant>VT_XXX</constant> <xref
linkend="com.constants"/>.
</simpara>
<simpara>
PHP can detect parameters passed by reference
automatically; they do not even need to be passed as VARIANT objects.
</simpara>
<simpara>
Consult the <acronym>MSDN</acronym> library for additional information
on the VARIANT type.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>codepage</parameter></term>
<listitem>
<simpara>
Specifies the codepage that is used to convert strings to
unicode. See the parameter of the same name in the
<xref linkend="class.com"/> class for more information.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</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:"~/.phpdoc/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
-->