mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-30 15:58:55 +00:00
20216b916e
Based on patch contributed by Máté Kocsis <kocsismate@woohoolabs.com>. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351554 c90b9560-bf6c-de11-be94-00142212c4b1
75 lines
2.4 KiB
XML
75 lines
2.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="compersisthelper.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>COMPersistHelper::__construct</refname>
|
|
<refpurpose>Construct a COMPersistHelper object</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<constructorsynopsis>
|
|
<modifier>public</modifier> <methodname>COMPersistHelper::__construct</methodname>
|
|
<methodparam choice="opt"><type class="union"><type>variant</type><type>null</type></type><parameter>variant</parameter></methodparam>
|
|
</constructorsynopsis>
|
|
<para>
|
|
Constructs a persistence helper object, usually associated with a
|
|
<parameter>variant</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>variant</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
A <acronym>COM</acronym> object which implements <interfacename>IDispatch</interfacename>.
|
|
To be able to successfully call any of <classname>COMPersistHelper</classname>'s methods, the object
|
|
has to implement <interfacename>IPersistFile</interfacename>, <interfacename>IPersistStream</interfacename>
|
|
and/or <interfacename>IPersistStreamInit</interfacename>.
|
|
</simpara>
|
|
<simpara>
|
|
Passing &null; as <parameter>variant</parameter> is only useful if the object is to be
|
|
loaded from a stream by calling <methodname>COMPersistHelper::LoadFromStream</methodname>.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<!-- Return values commented out, as constructors generally don't return a
|
|
value. Uncomment this if you do need a return values section (for
|
|
example, because there's also a procedural version of the method).
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
|
|
</para>
|
|
</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
|
|
-->
|