<?xml version="1.0" encoding="utf-8"?>
<!--
* Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET
*
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
*
-->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="h5cp" xml:lang="ja">
    <refnamediv>
        <refname>h5cp</refname>
        <refpurpose>オブジェクトをコピーする</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>呼び出し手順</title>
        <synopsis>
            h5cp(srcobj [, srcloc], destobj [, destloc])
            h5cp(srcobj [, srcloc], destfile, destloc)
            h5cp(srcfile, srcloc, destobj [, destloc])
            h5cp(srcfile, srcloc, destfile, destloc)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>引数</title>
        <variablelist>
            <varlistentry>
                <term>srcobj</term>
                <listitem>
                    <para>H5Object</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>destobj</term>
                <listitem>
                    <para>H5Object</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>srcloc</term>
                <listitem>
                    <para>コピー元を指定する文字列</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>destloc</term>
                <listitem>
                    <para>コピー先を指定する文字列</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>srcfile</term>
                <listitem>
                    <para>コピー元のファイル名(文字列)</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>destfile</term>
                <listitem>
                    <para>コピー先のファイル名(文字列)</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>説明</title>
        <para>オブジェクトを他の場所(同じファイルまたはそれ以外)にコピーします.</para>
        <para>新規に作成されたオブジェクトをコピーする前には, ファイルをフラッシュする必要があります.</para>
    </refsection>
    <refsection>
        <title>例</title>
        <programlisting role="example"><![CDATA[
// HDF5ファイルを作成
a = h5open(TMPDIR + "/test.h5");
b = h5open(TMPDIR + "/test1.h5");
// グループおよびデータセットを作成
h5group(a, "Grp_1");
h5write(a.root.Grp_1, "Dset_1", [1 2 ; 3 4]);
// コピーの際に修正を確実に反映するためにファイルをフラッシュ
h5flush(a);
// bの中にグループおよびデータセットを作成
h5group(b, "BGrp");
h5write(b("/BGrp"), "BDset", 11:18);
h5close(b)
// Dset_1をルートの下のDset_2にコピー
h5cp(a.root.Grp_1, "Dset_1", a, "Dset_2")
// BDsetをGrp_1の下のデータセットにコピー
h5cp(TMPDIR  +"/test1.h5", "/BGrp/BDset", a.root.Grp_1)
// コピー先の名前を変更可能
h5cp(TMPDIR  +"/test1.h5", "/BGrp/BDset", a.root.Grp_1, "The Foo Dataset")
// 処理を完了し, 全リソースを解放
h5close(a);
    ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>参照</title>
        <simplelist type="inline">
            <member>
                <link linkend="h5open">h5open</link>
            </member>
        </simplelist>
        <simplelist type="inline">
            <member>
                <link linkend="h5mv">h5mv</link>
            </member>
        </simplelist>
        <simplelist type="inline">
            <member>
                <link linkend="h5rm">h5rm</link>
            </member>
        </simplelist>
        <simplelist type="inline">
            <member>
                <link linkend="h5flush">h5flush</link>
            </member>
        </simplelist>
    </refsection>
    <refsection>
        <title>履歴</title>
        <revhistory>
            <revision>
                <revnumber>5.5.0</revnumber>
                <revremark>HDF5モジュールが導入されました.</revremark>
            </revision>
        </revhistory>
    </refsection>
</refentry>
