<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Print out a PHP class definition for a dispatchable interface</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.com-message-pump.html">com_message_pump</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.com-propget.html">com_propget</a></div>
<div class="up"><a href="ref.com.html">COM Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><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>
<div class="refsect1 description" id="refsect1-function.com-print-typeinfo-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>com_print_typeinfo</strong></span>
( <span class="methodparam"><span class="type">object</span> <code class="parameter">$comobject</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$dispinterface</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$wantsink</code><span class="initializer"> = false</span></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>
<div class="refsect1 parameters" id="refsect1-function.com-print-typeinfo-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">comobject</code></em></span>
<dd>
<p class="para">
<em><code class="parameter">comobject</code></em> 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 <span class="function"><a href="function.com-load-typelib.html" class="function">com_load_typelib()</a></span>).
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">dispinterface</code></em></span>
<dd>
<p class="para">
The name of an <em>IDispatch</em> descendant interface that you want to display.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">wantsink</code></em></span>
<dd>
<p class="para">
If set to <strong><code>TRUE</code></strong>, the corresponding sink interface will be displayed
instead.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.com-print-typeinfo-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.com-print-typeinfo-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.com-event-sink.html" class="function" rel="rdfs-seeAlso">com_event_sink()</a> - Connect events from a COM object to a PHP object</span></li>
<li class="member"> <span class="function"><a href="function.com-load-typelib.html" class="function" rel="rdfs-seeAlso">com_load_typelib()</a> - Loads a Typelib</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.com-message-pump.html">com_message_pump</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.com-propget.html">com_propget</a></div>
<div class="up"><a href="ref.com.html">COM Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
