<?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="h5umount" xml:lang="en">
    <refnamediv>
        <refname>h5umount</refname>
        <refpurpose>Unmount a previously mounted file.</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>
            h5umount(obj, location)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>obj</term>
                <listitem>
                    <para>a H5Object</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>location</term>
                <listitem>
                    <para>a string giving the mount point</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>Unmount a previously mounted file.</para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
// Create an HDF5 file
a = h5open(TMPDIR + "/test.h5", "w")

// we create a group which will be used as mount point
h5group(a, "/mnt");

// Create another file with a group and a dataset
b = h5open(TMPDIR + "/test1.h5", "w")
h5group(b, "Group_1");
h5write(b, "Group_1/Dataset_1", [1 2;3 4]);

// Mount b on a
h5mount(a, "/mnt", b)

// Now we can modify or read b like if we were in a
a.root.mnt.Group_1.Dataset_1.data
h5write(a.root.mnt.Group_1, "Dataset_1", [10 11;12 13])

// We can now unmount and remove the mount point
h5umount(a, "/mnt")
h5rm(a, "/mnt")

// We close all
h5close(a, b)

// Check that the modification in b is ok
h5dump(TMPDIR + "/test1.h5", "/Group_1/Dataset_1")
    ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="h5open">h5open</link>
            </member>
        </simplelist>
        <simplelist type="inline">
            <member>
                <link linkend="h5mount">h5mount</link>
            </member>
        </simplelist>
    </refsection>
    <refsection>
        <title>History</title>
        <revhistory>
            <revision>
                <revnumber>5.5.0</revnumber>
                <revremark>HDF5 module introduced.</revremark>
            </revision>
        </revhistory>
    </refsection>
</refentry>
