1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
<?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 role="COMPersistHelper">
<modifier>public</modifier> <methodname>COMPersistHelper::__construct</methodname>
<methodparam choice="opt"><type class="union"><type>variant</type><type>null</type></type><parameter>variant</parameter><initializer>&null;</initializer></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
-->
|
