<?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="h5ls" xml:lang="ja">
    <refnamediv>
        <refname>h5ls</refname>
        <refpurpose>HDF5オブジェクト (グループまたはデータセット)の内容の一覧を得る</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>呼び出し手順</title>
        <synopsis>
            content = h5ls(obj [, name [, filter]])
            content = h5ls(filename, name [, filter])
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>引数</title>
        <variablelist>
            <varlistentry>
                <term>obj</term>
                <listitem>
                    <para>H5Object</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>name</term>
                <listitem>
                    <para>一覧を得るためにオブジェクトのパスを指定する文字列</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>filename</term>
                <listitem>
                    <para>ファイル名を指定する文字列</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>filter</term>
                <listitem>
                    <para>フィルタの型を指定する文字列</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>content</term>
                <listitem>
                    <para>2列の文字列行列</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>説明</title>
        <para>
            グループまたはデータセットの内容の一覧を取得します.
            最初の列には名前, 2列目には要素の型が得られます.
        </para>
        <para>
            filterには値 'group' (または 'g'), 'dataset' (または 'd'), 'type' (または 't') および 'attribute' (または 'a')
            のどれかを指定できます.
            例えば, 'g' が指定された場合, グループのみが返されます.
        </para>
    </refsection>
    <refsection>
        <title>例</title>
        <programlisting role="example"><![CDATA[
x = int8(matrix(1:80, 10, 8));
save(TMPDIR + "/x.sod", "x"); // SODファイルはHDF5ファイル
// 作成されたファイルをオープン
a = h5open(TMPDIR + "/x.sod");
// aの内容の一覧を得る
h5ls(a)
// データセットのみ
h5ls(a, ".", "d")
// 属性のみ
h5ls(a, ".", "a");
// xという名前のデータセットを見て, 一覧を取得可能
h5ls(a.root.x) // a.root.x is equivalent to a("/x")
// 処理を完了し, 全リソースを解放
h5close(a);
    ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>参照</title>
        <simplelist type="inline">
            <member>
                <link linkend="h5open">h5open</link>
            </member>
        </simplelist>
    </refsection>
    <refsection>
        <title>履歴</title>
        <revhistory>
            <revision>
                <revnumber>5.5.0</revnumber>
                <revremark>HDF5モジュールが導入されました.</revremark>
            </revision>
        </revhistory>
    </refsection>
</refentry>
