php-doc-en/reference/com/functions/com-isenum.xml

74 lines
1.9 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='function.com-isenum' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>com_isenum</refname>
<refpurpose>Indicates if a COM object has an IEnumVariant interface for iteration [deprecated]</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>com_isenum</methodname>
<methodparam><type>variant</type><parameter>com_module</parameter></methodparam>
</methodsynopsis>
<para>
Checks to see if a COM object can be enumerated using the
<literal>Next()</literal> method hack.
See <xref linkend="class.com"/> class for more details on these
methods.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>com_module</parameter></term>
<listitem>
<para>
The COM object.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the object can be enumerated, &false; otherwise.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function does not exist in PHP 5; use the more natural
&foreach; statement to iterate over the contents of COM objects.
See <xref linkend="com.examples.foreach"/> for more details.
</para>
</note>
</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
-->