svn: /phpdoc/ja/trunk/reference/com/ book.xml compersisthelper/construct.xml compersisthelper/getcurfilename.xml compersisthelper/getmaxstreamsize.xml compersisthelper/initnew.xml compersisthelper/loadfromfile.xml compersisthelper/loadfromstream.xml compersisthelper/savetofile.xml compersisthelper/savetostream.xml compersisthelper.xml
[email protected] (Yoshinari Takaoka)
| Newsgroups | php.doc.ja |
|---|---|
| Message-ID | <[email protected]> |
mumumu Fri, 28 Feb 2020 18:40:55 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=349262
Log:
Document COMPersistHelper
Changed paths:
U phpdoc/ja/trunk/reference/com/book.xml
A phpdoc/ja/trunk/reference/com/compersisthelper/
A phpdoc/ja/trunk/reference/com/compersisthelper/construct.xml
A phpdoc/ja/trunk/reference/com/compersisthelper/getcurfilename.xml
A phpdoc/ja/trunk/reference/com/compersisthelper/getmaxstreamsize.xml
A phpdoc/ja/trunk/reference/com/compersisthelper/initnew.xml
A phpdoc/ja/trunk/reference/com/compersisthelper/loadfromfile.xml
A phpdoc/ja/trunk/reference/com/compersisthelper/loadfromstream.xml
A phpdoc/ja/trunk/reference/com/compersisthelper/savetofile.xml
A phpdoc/ja/trunk/reference/com/compersisthelper/savetostream.xml
A phpdoc/ja/trunk/reference/com/compersisthelper.xml
svn-diffs-349262.txt
(text/x-diff, 28.2 KB)
Modified: phpdoc/ja/trunk/reference/com/book.xml
===================================================================
--- phpdoc/ja/trunk/reference/com/book.xml 2020-02-28 17:40:19 UTC (rev 349261)
+++ phpdoc/ja/trunk/reference/com/book.xml 2020-02-28 18:40:55 UTC (rev 349262)
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<!-- EN-Revision: 347691 Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 349255 Maintainer: takagi Status: ready -->
<!-- CREDITS: hirokawa,mumumu -->
<book xml:id="book.com" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -60,6 +60,7 @@
&reference.com.com;
&reference.com.dotnet;
&reference.com.variant;
+ &reference.com.compersisthelper;
&reference.com.com-exception;
&reference.com.reference;
Added: phpdoc/ja/trunk/reference/com/compersisthelper/construct.xml
===================================================================
--- phpdoc/ja/trunk/reference/com/compersisthelper/construct.xml (rev 0)
+++ phpdoc/ja/trunk/reference/com/compersisthelper/construct.xml 2020-02-28 18:40:55 UTC (rev 349262)
@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 349255 Maintainer: mumumu Status: ready -->
+
+<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>COMPersistHelper オブジェクトを構築する</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <constructorsynopsis>
+ <modifier>public</modifier> <methodname>COMPersistHelper::__construct</methodname>
+ <methodparam><type>variant</type><parameter>com_object</parameter><initializer>&null;</initializer></methodparam>
+ </constructorsynopsis>
+ <para>
+ 永続化を助けるオブジェクトを構築します。
+ これは通常、<parameter>com_object</parameter> に結びつけて使います。
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>com_object</parameter></term>
+ <listitem>
+ <simpara>
+ <interfacename>IDispatch</interfacename> を実装した <acronym>COM</acronym> オブジェクト。
+ <classname>COMPersistHelper</classname> のあらゆるメソッドを呼べるようにするためには、
+ <interfacename>IPersistFile</interfacename>,
+ <interfacename>IPersistStream</interfacename> かつ/または <interfacename>IPersistStreamInit</interfacename>
+ をオブジェクトが実装していなければなりません。
+ </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
+-->
Property changes on: phpdoc/ja/trunk/reference/com/compersisthelper/construct.xml
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
\ No newline at end of property
Added: phpdoc/ja/trunk/reference/com/compersisthelper/getcurfilename.xml
===================================================================
--- phpdoc/ja/trunk/reference/com/compersisthelper/getcurfilename.xml (rev 0)
+++ phpdoc/ja/trunk/reference/com/compersisthelper/getcurfilename.xml 2020-02-28 18:40:55 UTC (rev 349262)
@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 349255 Maintainer: mumumu Status: ready -->
+
+<refentry xml:id="compersisthelper.getcurfilename" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>COMPersistHelper::GetCurFileName</refname>
+ <refpurpose>現在のファイル名を取得する</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> <type>string</type><methodname>COMPersistHelper::GetCurFileName</methodname>
+ <void />
+ </methodsynopsis>
+ <para>
+ オブジェクトに関連付けられた現在のファイル名を取得します。
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ オブジェクトに関連付けられた現在のファイル名を返します。
+ </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ 関連付けられたオブジェクトが <acronym>COM</acronym> のインターフェイス
+ <interfacename>IPersistFile</interfacename> を実装していないか、
+ <methodname>IPersistFile::GetCurFile</methodname> の呼び出しに失敗した場合、
+ <classname>com_exception</classname> がスローされます。
+ </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
+-->
Property changes on: phpdoc/ja/trunk/reference/com/compersisthelper/getcurfilename.xml
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
\ No newline at end of property
Added: phpdoc/ja/trunk/reference/com/compersisthelper/getmaxstreamsize.xml
===================================================================
--- phpdoc/ja/trunk/reference/com/compersisthelper/getmaxstreamsize.xml (rev 0)
+++ phpdoc/ja/trunk/reference/com/compersisthelper/getmaxstreamsize.xml 2020-02-28 18:40:55 UTC (rev 349262)
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 349255 Maintainer: mumumu Status: ready -->
+
+<refentry xml:id="compersisthelper.getmaxstreamsize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>COMPersistHelper::GetMaxStreamSize</refname>
+ <refpurpose>ストリームのサイズの最大値を取得する</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> <type>int</type><methodname>COMPersistHelper::GetMaxStreamSize</methodname>
+ <void />
+ </methodsynopsis>
+ <para>
+ オブジェクトを保存するのに必要なストリームのサイズを取得します(バイト単位)。
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ オブジェクトを保存するのに必要なストリームのサイズを返します(バイト単位)。
+ </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ 関連付けられたオブジェクトが <acronym>COM</acronym> のインターフェイス
+ <interfacename>IPersistStreamInit</interfacename>
+ と <interfacename>IPersistStream</interfacename> をいずれも実装していないか、
+ <methodname>IPersistStream::GetSizeMax</methodname> の呼び出しに失敗した場合、
+ <classname>com_exception</classname> がスローされます。
+ </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
+-->
Property changes on: phpdoc/ja/trunk/reference/com/compersisthelper/getmaxstreamsize.xml
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
\ No newline at end of property
Added: phpdoc/ja/trunk/reference/com/compersisthelper/initnew.xml
===================================================================
--- phpdoc/ja/trunk/reference/com/compersisthelper/initnew.xml (rev 0)
+++ phpdoc/ja/trunk/reference/com/compersisthelper/initnew.xml 2020-02-28 18:40:55 UTC (rev 349262)
@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 349255 Maintainer: mumumu Status: ready -->
+
+<refentry xml:id="compersisthelper.initnew" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>COMPersistHelper::InitNew</refname>
+ <refpurpose>オブジェクトをデフォルトの状態に初期化する</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> <type>bool</type><methodname>COMPersistHelper::InitNew</methodname>
+ <void />
+ </methodsynopsis>
+ <para>
+ オブジェクトをデフォルトの状態に初期化します
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ 関連付けられたオブジェクトが <acronym>COM</acronym> のインターフェイス
+ <interfacename>IPersistStreamInit</interfacename> を実装していないか、
+ <methodname>IPersistStreamInit::Init</methodname> の呼び出しに失敗した場合、
+ <classname>com_exception</classname> がスローされます。
+ </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
+-->
Property changes on: phpdoc/ja/trunk/reference/com/compersisthelper/initnew.xml
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
\ No newline at end of property
Added: phpdoc/ja/trunk/reference/com/compersisthelper/loadfromfile.xml
===================================================================
--- phpdoc/ja/trunk/reference/com/compersisthelper/loadfromfile.xml (rev 0)
+++ phpdoc/ja/trunk/reference/com/compersisthelper/loadfromfile.xml 2020-02-28 18:40:55 UTC (rev 349262)
@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 349255 Maintainer: mumumu Status: ready -->
+
+<refentry xml:id="compersisthelper.loadfromfile" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>COMPersistHelper::LoadFromFile</refname>
+ <refpurpose>オブジェクトをファイルから読み込む</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> <type>bool</type><methodname>COMPersistHelper::LoadFromFile</methodname>
+ <methodparam><type>string</type><parameter>path</parameter></methodparam>
+ <methodparam><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
+ </methodsynopsis>
+ <para>
+ 指定されたファイルを開き、そのファイルの内容でオブジェクトを初期化します。
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>path</parameter></term>
+ <listitem>
+ <simpara>
+ 読み込むオブジェクトが保存されたファイル名
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>flags</parameter></term>
+ <listitem>
+ <simpara>
+ ファイルをオープンする際のアクセスモード。
+ 有効な値は <link xlink:href="https://docs.microsoft.com/en-us/windows/win32/stg/stgm-constants">STGM enumeration</link> を参照してください。
+ メソッドはこの値を参考程度に扱い、必要に応じてより制限的なパーミッションを追加します。
+ <parameter>flags</parameter> に <literal>0</literal> を指定すると、
+ ユーザーがファイルを開くときのデフォルトのパーミッションを使ってファイルを開きます。
+ </simpara>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ 関連付けられたオブジェクトが <acronym>COM</acronym> のインターフェイス
+ <interfacename>IPersistFile</interfacename> を実装していないか、
+ <methodname>IPersistFile::Load</methodname> の呼び出しに失敗した場合、
+ <classname>com_exception</classname> がスローされます。
+ </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
+-->
Property changes on: phpdoc/ja/trunk/reference/com/compersisthelper/loadfromfile.xml
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
\ No newline at end of property
Added: phpdoc/ja/trunk/reference/com/compersisthelper/loadfromstream.xml
===================================================================
--- phpdoc/ja/trunk/reference/com/compersisthelper/loadfromstream.xml (rev 0)
+++ phpdoc/ja/trunk/reference/com/compersisthelper/loadfromstream.xml 2020-02-28 18:40:55 UTC (rev 349262)
@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 349255 Maintainer: mumumu Status: ready -->
+
+<refentry xml:id="compersisthelper.loadfromstream" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>COMPersistHelper::LoadFromStream</refname>
+ <refpurpose>ストリームからオブジェクトを読み込む</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> <type>bool</type><methodname>COMPersistHelper::LoadFromStream</methodname>
+ <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ 以前オブジェクトを保存したストリームの内容でオブジェクトを初期化します。
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>stream</parameter></term>
+ <listitem>
+ <simpara>
+ オブジェクトを読み込むストリーム&resource;
+ </simpara>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ 関連付けられたオブジェクトが <acronym>COM</acronym> のインターフェイス
+ <interfacename>IPersistStream</interfacename> を実装していないか、
+ <methodname>IPersistStream::Load</methodname> の呼び出しに失敗した場合、
+ <classname>com_exception</classname> がスローされます。
+ </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
+-->
Property changes on: phpdoc/ja/trunk/reference/com/compersisthelper/loadfromstream.xml
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
\ No newline at end of property
Added: phpdoc/ja/trunk/reference/com/compersisthelper/savetofile.xml
===================================================================
--- phpdoc/ja/trunk/reference/com/compersisthelper/savetofile.xml (rev 0)
+++ phpdoc/ja/trunk/reference/com/compersisthelper/savetofile.xml 2020-02-28 18:40:55 UTC (rev 349262)
@@ -0,0 +1,106 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 349255 Maintainer: mumumu Status: ready -->
+
+<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>オブジェクトをファイルに保存する</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> <type>bool</type><methodname>COMPersistHelper::SaveToFile</methodname>
+ <methodparam><type>string</type><parameter>filename</parameter><initializer>&null;</initializer></methodparam>
+ <methodparam><type>bool</type><parameter>remember</parameter><initializer>&true;</initializer></methodparam>
+ </methodsynopsis>
+ <para>
+ オブジェクトのコピーを指定されたファイルに保存します
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <simpara>
+ オブジェクトを保存するファイル名
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>remember</parameter></term>
+ <listitem>
+ <simpara>
+ <parameter>filename</parameter> パラメータを現在作業中のファイルに使うかを指定します。
+ &true; を指定すると、
+ <parameter>filename</parameter> は現在作業中のファイルに指定され、
+ 保存された後にダーティーフラグがクリアされます。
+ &false; を指定すると、保存する操作は "ファイルに名前を付けて保存" する操作になります。
+ この場合、現在のファイルは変更されず、オブジェクトのダーティーフラグはクリアされません。
+ </simpara>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ 関連付けられたオブジェクトが <acronym>COM</acronym> のインターフェイス
+ <interfacename>IPersistFile</interfacename> を実装していないか、
+ <methodname>IPersistFile::Save</methodname> の呼び出しに失敗した場合、
+ <classname>com_exception</classname> がスローされます。
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <example xml:id="compersisthelper.savetofile.example.basic">
+ <title><methodname>COMPersistHelper::saveToFile</methodname> の基本的な使い方</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
+-->
Property changes on: phpdoc/ja/trunk/reference/com/compersisthelper/savetofile.xml
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
\ No newline at end of property
Added: phpdoc/ja/trunk/reference/com/compersisthelper/savetostream.xml
===================================================================
--- phpdoc/ja/trunk/reference/com/compersisthelper/savetostream.xml (rev 0)
+++ phpdoc/ja/trunk/reference/com/compersisthelper/savetostream.xml 2020-02-28 18:40:55 UTC (rev 349262)
@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 349255 Maintainer: mumumu Status: ready -->
+
+<refentry xml:id="compersisthelper.savetostream" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>COMPersistHelper::SaveToStream</refname>
+ <refpurpose>オブジェクトをストリームに保存する</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> <type>bool</type><methodname>COMPersistHelper::SaveToStream</methodname>
+ <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ オブジェクトを指定されたストリームに保存します。
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <variablelist>
+ <varlistentry>
+ <term><parameter>stream</parameter></term>
+ <listitem>
+ <simpara>
+ オブジェクトを保存するストリーム &resource;
+ </simpara>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ 関連付けられたオブジェクトが <acronym>COM</acronym> のインターフェイス
+ <interfacename>IPersistStream</interfacename> と <interfacename>IPersistStreamInit</interfacename>
+ をいずれも実装していないか、
+ <methodname>IPersistStream::Save</methodname> の呼び出しに失敗した場合、
+ <classname>com_exception</classname> がスローされます。
+ </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
+-->
Property changes on: phpdoc/ja/trunk/reference/com/compersisthelper/savetostream.xml
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
\ No newline at end of property
Added: phpdoc/ja/trunk/reference/com/compersisthelper.xml
===================================================================
--- phpdoc/ja/trunk/reference/com/compersisthelper.xml (rev 0)
+++ phpdoc/ja/trunk/reference/com/compersisthelper.xml 2020-02-28 18:40:55 UTC (rev 349262)
@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 349255 Maintainer: mumumu Status: ready -->
+
+<phpdoc:classref xml:id="class.compersisthelper" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+ <title>COMPersistHelper クラス</title>
+ <titleabbrev>COMPersistHelper</titleabbrev>
+
+ <partintro>
+
+<!-- {{{ COMPersistHelper intro -->
+ <section xml:id="compersisthelper.intro">
+ &reftitle.intro;
+ <para>
+ <classname>COMPersistHelper</classname> クラスは、
+ &php.ini; の <link linkend='ini.open-basedir'>open_basedir</link> ディレクティブと
+ ストリーム &resource; を考慮して
+ <acronym>COM</acronym> と <acronym>PHP</acronym> の相互運用性を高めます。
+ </para>
+ </section>
+<!-- }}} -->
+
+ <section xml:id="compersisthelper.synopsis">
+ &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+ <classsynopsis>
+ <ooclass><classname>COMPersistHelper</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+ <classsynopsisinfo>
+ <ooclass>
+ <modifier>final</modifier>
+ <classname>COMPersistHelper</classname>
+ </ooclass>
+ </classsynopsisinfo>
+<!-- }}} -->
+
+ <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.compersisthelper')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
+ <xi:fallback />
+ </xi:include>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.compersisthelper')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
+ <xi:fallback />
+ </xi:include>
+ </classsynopsis>
+<!-- }}} -->
+
+ </section>
+
+ </partintro>
+
+ &reference.com.entities.compersisthelper;
+
+</phpdoc:classref>
+
+<!-- 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
+-->
Property changes on: phpdoc/ja/trunk/reference/com/compersisthelper.xml
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
\ No newline at end of property