mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00

And everyone should follow that. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@32721 c90b9560-bf6c-de11-be94-00142212c4b1
206 lines
5.9 KiB
XML
206 lines
5.9 KiB
XML
<reference id="ref.com">
|
|
<title>COM support functions for Windows</title>
|
|
<titleabbrev>COM</titleabbrev>
|
|
|
|
<partintro>
|
|
<simpara>
|
|
These functions are only available on the Windows version of
|
|
PHP. These functions have been added in PHP 4.
|
|
</simpara>
|
|
</partintro>
|
|
|
|
<refentry id="function.com-load">
|
|
<refnamediv>
|
|
<refname>com_load</refname>
|
|
<refpurpose>
|
|
Creates a new reference to a COM component
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>string <function>com_load</function></funcdef>
|
|
<paramdef>string <parameter>module name</parameter></paramdef>
|
|
<paramdef>string
|
|
<parameter>
|
|
<optional>server name</optional>
|
|
</parameter>
|
|
</paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
<para>
|
|
<function>com_load</function> creates a new COM component and
|
|
returns a reference to it. Returns <literal>false</literal> on
|
|
failiure.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.com-invoke">
|
|
<refnamediv>
|
|
<refname>com_invoke</refname>
|
|
<refpurpose>
|
|
Calls a COM component's method.
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>mixed <function>com_invoke</function></funcdef>
|
|
<paramdef>resource <parameter>com_object</parameter></paramdef>
|
|
<paramdef>string <parameter>function_name</parameter></paramdef>
|
|
<paramdef>mixed
|
|
<parameter>
|
|
<optional>function parameters, ...</optional>
|
|
</parameter>
|
|
</paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
<para>
|
|
<function>Com_invoke</function> invokes a method of the COM
|
|
component referenced by
|
|
<parameter>com_object</parameter>. Returns
|
|
<literal>false</literal> on error, returns the
|
|
<parameter>function_name</parameter>'s return value on success.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.com-propget">
|
|
<refnamediv>
|
|
<refname>com_propget</refname>
|
|
<refpurpose>
|
|
Gets the value of a COM Component's property
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>mixed <function>com_propget</function></funcdef>
|
|
<paramdef>resource <parameter>com_object</parameter></paramdef>
|
|
<paramdef>string <parameter>property</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
<para>
|
|
This function is an alias for <function>com_get</function>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.com-get">
|
|
<refnamediv>
|
|
<refname>com_get</refname>
|
|
<refpurpose>
|
|
Gets the value of a COM Component's property
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>mixed <function>com_get</function></funcdef>
|
|
<paramdef>resource <parameter>com_object</parameter></paramdef>
|
|
<paramdef>string <parameter>property</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns the value of the <parameter>property</parameter> of the
|
|
COM component referenced by <parameter>com_object</parameter>.
|
|
Returns <literal>false</literal> on error.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.com-propput">
|
|
<refnamediv>
|
|
<refname>com_propput</refname>
|
|
<refpurpose>
|
|
Assigns a value to a COM component's property
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>void <function>com_propput</function></funcdef>
|
|
<paramdef>resource <parameter>com_object</parameter></paramdef>
|
|
<paramdef>string <parameter>property</parameter></paramdef>
|
|
<paramdef>mixed <parameter>value</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
<para>
|
|
This function is an alias for <function>com_set</function>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.com-propset">
|
|
<refnamediv>
|
|
<refname>com_propset</refname>
|
|
<refpurpose>
|
|
Assigns a value to a COM component's property
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>void <function>com_propset</function></funcdef>
|
|
<paramdef>resource <parameter>com_object</parameter></paramdef>
|
|
<paramdef>string <parameter>property</parameter></paramdef>
|
|
<paramdef>mixed <parameter>value</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
<para>
|
|
This function is an alias for <function>com_set</function>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.com-set">
|
|
<refnamediv>
|
|
<refname>com_set</refname>
|
|
<refpurpose>
|
|
Assigns a value to a COM component's property
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>void <function>com_set</function></funcdef>
|
|
<paramdef>resource <parameter>com_object</parameter></paramdef>
|
|
<paramdef>string <parameter>property</parameter></paramdef>
|
|
<paramdef>mixed <parameter>value</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
<para>
|
|
Sets the value of the <parameter>property</parameter> of the COM
|
|
component referenced by <parameter>com_object</parameter>.
|
|
Returns <literal>true</literal> if
|
|
<parameter>property</parameter> is set. Returns
|
|
<literal>false</literal> on error.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
</reference>
|
|
|
|
<!-- 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
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
-->
|