2681fe3c0b2a96d6c6e1ec0c92b56448dbc1e694
[scilab.git] / scilab / modules / windows_tools / help / en_US / istssession.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
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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="istssession">
17     <refnamediv>
18         <refname>istssession</refname>
19         <refpurpose>Determines if scilab is launched from a ms terminal service session (Windows only)</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>istssession()</synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Description</title>
27         <para>
28             tf =istssession() returns boolean (%t) if scilab is launched from a ms
29             terminal service session and boolean (%f) otherwise.
30         </para>
31     </refsection>
32     <refsection>
33         <title>Examples</title>
34         <programlisting role="example"><![CDATA[
35 if getos() == 'Windows' then
36   if istssession() then
37     disp('Scilab from a ms terminal service session.');
38   else
39     disp('Scilab standard session.');
40   end
41 end
42  ]]></programlisting>
43     </refsection>
44 </refentry>