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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="compersisthelper.savetofile" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>COMPersistHelper::SaveToFile</refname>
<refpurpose>Save object to file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="COMPersistHelper">
<modifier>public</modifier> <type>bool</type><methodname>COMPersistHelper::SaveToFile</methodname>
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>remember</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
Saves a copy of the object to the specified file.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<simpara>
The name of the file to which to save the object.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>remember</parameter></term>
<listitem>
<simpara>
Indicates whether the <parameter>filename</parameter> parameter is to be used as the current
working file. If &true;, <parameter>filename</parameter> becomes the current file and the
object is supposed to clear its dirty flag after the save. If &false;, this save operation is
a "Save A Copy As ..." operation. In this case, the current file is unchanged and the object
is not supposed to clear its dirty flag.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
A <classname>com_exception</classname> is thrown if the associated object does not
implement the <acronym>COM</acronym> interface <interfacename>IPersistFile</interfacename>,
or when calling the <methodname>IPersistFile::Save</methodname> method failed.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="compersisthelper.savetofile.example.basic">
<title>Basic <methodname>COMPersistHelper::saveToFile</methodname> Usage</title>
<programlisting role="php">
<![CDATA[
<?php
$word = new COM('Word.Application');
$doc = $word->Documents->Add();
$ph = new COMPersistHelper($doc);
$ph->SaveToFile('C:\\Users\\cmb\\Documents\\my.docx');
$word->Quit();
?>
]]>
</programlisting>
</example>
</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
-->
|
