Source of: /manual/en/function.com-print-typeinfo.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.com.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.com-print-typeinfo.php',
1 => 'com_print_typeinfo',
),
'up' =>
array (
0 => 'ref.com.php',
1 => 'COM Functions',
),
'prev' =>
array (
0 => 'function.com-message-pump.php',
1 => 'com_message_pump',
),
'next' =>
array (
0 => 'function.com-propget.php',
1 => 'com_propget',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.com-print-typeinfo" class="refentry">
<div class="refnamediv">
<h1 class="refname">com_print_typeinfo</h1>
<p class="verinfo">(PHP 4 >= 4.2.0, PHP 5)</p><p class="refpurpose"><span class="refname">com_print_typeinfo</span> — <span class="dc-title">Print out a PHP class definition for a dispatchable interface</span></p>
</div>
<a name="function.com-print-typeinfo.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>com_print_typeinfo</b></span>
( <span class="methodparam"><span class="type">object</span> <tt class="parameter">$comobject</tt></span>
[, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$dispinterface</tt></span>
[, <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$wantsink</tt></span>
]] )</div>
<p class="para rdfs-comment">
The purpose of this function is to help generate a skeleton class for use
as an event sink. You may also use it to generate a dump of any COM
object, provided that it supports enough of the introspection interfaces,
and that you know the name of the interface you want to display.
</p>
</div>
<a name="function.com-print-typeinfo.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">comobject</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
<i><tt class="parameter">comobject</tt></i>
should be either an instance of a COM
object, or be the name of a typelibrary (which will be resolved according
to the rules set out in <a href="function.com-load-typelib.php" class="function">com_load_typelib()</a>).
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">dispinterface</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The name of an IDispatch descendant interface that you want to display.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">wantsink</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
If set to <b><tt class="constant">TRUE</tt></b>, the corresponding sink interface will be displayed
instead.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.com-print-typeinfo.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.com-print-typeinfo.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.com-event-sink.php" class="function" rel="rdfs-seeAlso">com_event_sink()</a> - Connect events from a COM object to a PHP object</li>
<li class="member"><a href="function.com-load-typelib.php" class="function" rel="rdfs-seeAlso">com_load_typelib()</a> - Loads a Typelib</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
