1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.variant-get-type" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>variant_get_type</refname>
<refpurpose>Returns the type of a variant object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>variant_get_type</methodname>
<methodparam><type>variant</type><parameter>variant</parameter></methodparam>
</methodsynopsis>
<para>
Returns the type of a variant object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>variant</parameter></term>
<listitem>
<para>
The variant object.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
This function returns an integer value that indicates the type of
<parameter>variant</parameter>, which can be an instance of
<xref linkend="class.com"/>, <xref linkend="class.dotnet"/> or
<xref linkend="class.variant"/> classes. The return value can be compared
to one of the <constant>VT_XXX</constant> constants.
</para>
<para>
The return value for COM and DOTNET objects will usually be
<constant>VT_DISPATCH</constant>; the only reason this function works for
those classes is because COM and DOTNET are descendants of VARIANT.
</para>
<para>
In PHP versions prior to 5, you could obtain this information from
instances of the VARIANT class ONLY, by reading a fake
<parameter>type</parameter> property. See the <xref
linkend="class.variant"/> class for more information on
this.
</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:"~/.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
-->
|