Add sample SOD and ZCOS icons files
[scilab.git] / scilab / modules / fileio / help / en_US / isdir.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) 2008 - INRIA - Serge STEER
5  * ...
6  * 
7  * This file must be used under the terms of the CeCILL.
8  * This source file is licensed as described in the file COPYING, which
9  * you should have received as part of this distribution.  The terms
10  * are also available at    
11  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
12  *
13  -->
14 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="isdir">
15     <refnamediv>
16         <refname>isdir</refname>
17         <refpurpose>checks if argument is a directory path</refpurpose>
18     </refnamediv>
19     <refsynopsisdiv>
20         <title>Calling Sequence</title>
21         <synopsis>r = isdir(path)</synopsis>
22     </refsynopsisdiv>
23     <refsection>
24         <title>Arguments</title>
25         <variablelist>
26             <varlistentry>
27                 <term>path</term>
28                 <listitem>
29                     <para>a character string or a matrix of strings: a directory pathname.</para>
30                 </listitem>
31             </varlistentry>
32             <varlistentry>
33                 <term>r</term>
34                 <listitem>
35                     <para>
36                         a boolean: <constant>%t</constant> if <varname>path</varname> is a path to a directory.
37                     </para>
38                 </listitem>
39             </varlistentry>
40         </variablelist>
41     </refsection>
42     <refsection>
43         <title>Description</title>
44         <para>
45             <code>r = isdir(path)</code> checks if <varname>path</varname> is a path to a directory.
46         </para>
47     </refsection>
48     <refsection>
49         <title>Reference</title>
50         <para>
51             This function is based on the C function 
52             <function>stat</function>. The <literal>SCI</literal> and <literal>~</literal> shortcuts for Scilab directory and home directory are handled.
53         </para>
54     </refsection>
55     <refsection>
56         <title>Examples</title>
57         <programlisting role="example"><![CDATA[ 
58 isdir(TMPDIR)
59 isdir SCI/etc/scilab.start
60  ]]></programlisting>
61     </refsection>
62     <refsection role="see also">
63         <title>See Also</title>
64         <simplelist type="inline">
65             <member>
66                 <link linkend="isfile">isfile</link>
67             </member>
68         </simplelist>
69         <member>
70             <link linkend="fileinfo">fileinfo</link>
71         </member>
72     </refsection>
73 </refentry>