Bug Fix #14415 - Corrected some spellings error in help pages
[scilab.git] / scilab / modules / hdf5 / help / en_US / h5get.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <!--
3 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4 * Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET
5 *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14 *
15 -->
16 <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="h5get" xml:lang="en">
17     <refnamediv>
18         <refname>h5get</refname>
19         <refpurpose>Get a named object</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>
24             nobj = h5get(obj, location [, isAttr])
25         </synopsis>
26     </refsynopsisdiv>
27     <refsection>
28         <title>Arguments</title>
29         <variablelist>
30             <varlistentry>
31                 <term>obj</term>
32                 <listitem>
33                     <para>a H5Object</para>
34                 </listitem>
35             </varlistentry>
36             <varlistentry>
37                 <term>location</term>
38                 <listitem>
39                     <para>a string giving the location</para>
40                 </listitem>
41             </varlistentry>
42             <varlistentry>
43                 <term>isAttr</term>
44                 <listitem>
45                     <para>a boolean to indicate that an attribute must be got</para>
46                 </listitem>
47             </varlistentry>
48             <varlistentry>
49                 <term>nobj</term>
50                 <listitem>
51                     <para>a H5Object</para>
52                 </listitem>
53             </varlistentry>
54         </variablelist>
55     </refsection>
56     <refsection>
57         <title>Description</title>
58         <para>Get the object with the given location under obj. If isAttr is %T, an H5 object is returned (if it exists), by default isAttr is %F.</para>
59     </refsection>
60     <refsection>
61         <title>Examples</title>
62         <programlisting role="example"><![CDATA[
63 x = ["Hello" "World"; "Salut" "Monde"];
64 save(TMPDIR + "/x.sod", "x"); // SOD files are HDF5 ones
65
66 // Open the created file
67 a = h5open(TMPDIR + "/x.sod");
68
69 // Get the root object, this equivalent to a.root or a("/")
70 r = h5get(a, "/")
71
72 // Get the dataset "x"
73 x = h5get(a, "/x") // or h5get(a.root, "x")
74 x.data
75
76 // Get an inexisting dataset
77 y = h5get(a.root, "blahblah")
78
79 // Get an attribute
80 attr = h5get(a.root, "SCILAB_scilab_version", %t)
81 attr.data
82
83 // We close all
84 h5close(a)
85     ]]></programlisting>
86     </refsection>
87     <refsection role="see also">
88         <title>See Also</title>
89         <simplelist type="inline">
90             <member>
91                 <link linkend="h5open">h5open</link>
92             </member>
93         </simplelist>
94     </refsection>
95     <refsection>
96         <title>History</title>
97         <revhistory>
98             <revision>
99                 <revnumber>5.5.0</revnumber>
100                 <revremark>HDF5 module introduced.</revremark>
101             </revision>
102         </revhistory>
103     </refsection>
104 </refentry>