mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 17:08:54 +00:00
Begining of some COM documentation.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@31529 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
James Moore
parent
500f9ce96e
commit
bac76ed3d7
1 changed files with 60 additions and 32 deletions
|
|
@ -12,7 +12,9 @@
|
|||
<refentry id="function.com-load">
|
||||
<refnamediv>
|
||||
<refname>com_load</refname>
|
||||
<refpurpose>???</refpurpose>
|
||||
<refpurpose>
|
||||
Creates a new reference to a COM component.
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
|
@ -28,6 +30,9 @@
|
|||
</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>
|
||||
|
|
@ -35,14 +40,16 @@
|
|||
<refentry id="function.com-invoke">
|
||||
<refnamediv>
|
||||
<refname>com_invoke</refname>
|
||||
<refpurpose>???</refpurpose>
|
||||
<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>object</parameter></paramdef>
|
||||
<paramdef>resource <parameter>com_object</parameter></paramdef>
|
||||
<paramdef>string <parameter>function_name</parameter></paramdef>
|
||||
<paramdef>mixed
|
||||
<parameter>
|
||||
|
|
@ -52,6 +59,10 @@
|
|||
</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>
|
||||
|
|
@ -59,18 +70,21 @@
|
|||
<refentry id="function.com-propget">
|
||||
<refnamediv>
|
||||
<refname>com_propget</refname>
|
||||
<refpurpose>???</refpurpose>
|
||||
<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>object</parameter></paramdef>
|
||||
<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>
|
||||
|
|
@ -78,18 +92,23 @@
|
|||
<refentry id="function.com-get">
|
||||
<refnamediv>
|
||||
<refname>com_get</refname>
|
||||
<refpurpose>???</refpurpose>
|
||||
<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>object</parameter></paramdef>
|
||||
<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>
|
||||
|
|
@ -97,19 +116,22 @@
|
|||
<refentry id="function.com-propput">
|
||||
<refnamediv>
|
||||
<refname>com_propput</refname>
|
||||
<refpurpose>???</refpurpose>
|
||||
<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>object</parameter></paramdef>
|
||||
<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>
|
||||
|
|
@ -117,35 +139,16 @@
|
|||
<refentry id="function.com-propset">
|
||||
<refnamediv>
|
||||
<refname>com_propset</refname>
|
||||
<refpurpose>???</refpurpose>
|
||||
<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>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_propput</function>.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.com-set">
|
||||
<refnamediv>
|
||||
<refname>com_set</refname>
|
||||
<refpurpose>???</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>void <function>com_set</function></funcdef>
|
||||
<paramdef>resource <parameter>object</parameter></paramdef>
|
||||
<paramdef>resource <parameter>com_object</parameter></paramdef>
|
||||
<paramdef>string <parameter>property</parameter></paramdef>
|
||||
<paramdef>mixed <parameter>value</parameter></paramdef>
|
||||
</funcprototype>
|
||||
|
|
@ -156,6 +159,31 @@
|
|||
</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
|
||||
|
|
|
|||
Loading…
Reference in a new issue