<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2008 - INRIA - Allan CORNET
 * ...
 *
 * 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:ns4="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="getlongpathname" xml:lang="en">
    <refnamediv>
        <refname>getlongpathname</refname>
        <refpurpose>gets long path name</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>
            longpath = getlongpathname(shortpath)
            [longpath, bOK] = getlongpathname(shortpath)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>shortpath</term>
                <listitem>
                    <para>a character string or matrix of strings: the short path.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>longpath</term>
                <listitem>
                    <para>a character string or matrix of strings: the long path.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>bOK</term>
                <listitem>
                    <para>
                        a boolean or a matrix of boolean: <constant>%T</constant> if
                        path has been converted else <constant>%F</constant>.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            The <function>getlongpathname</function> primitive converts the
            specified path <varname>shortpath</varname> to its long form. If no long path is found, this
            primitive returns the specified name.
        </para>
        <para>
            <note>
                Note: If the path cannot be converted (<varname>bOK</varname> is <constant>%F</constant>) and in particular if the
                operating system is not Windows, the returned long path is identical to the
                input short path.
            </note>
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example">
            <![CDATA[
[longpath,bOK]=getlongpathname(SCI)
[longpaths,bOKs]=getlongpathname([SCI;SCI])
 ]]>
        </programlisting>
    </refsection>
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="getshortpathname">getshortpathname</link>
            </member>
            <member>
                <link linkend="getrelativefilename">getrelativefilehname</link>
            </member>
            <member>
                <link linkend="pwd">pwd</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
