summaryrefslogtreecommitdiff
path: root/modules/string/help/en_US/ascii.xml
blob: 45395a3f1f4051416ae47cf672ab639b98fd310d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) INRIA - 
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at    
 * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
 *
 -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="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="ascii" xml:lang="en">
    <refnamediv>
        <refname>ascii</refname>
        <refpurpose>string ASCII conversions</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>a = ascii(txt)
            txt = ascii(a)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>txt</term>
                <listitem>
                    <para>a character string or a matrix of character strings.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>a</term>
                <listitem>
                    <para>a vector of integer ASCII codes</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            This function converts Scilab string to a vector of ASCII code (the first 127
            codes are ASCII) or vector of ASCII code to Scilab strings.
        </para>
        <para>
            If <varname>txt</varname> is a matrix of string, <code>ascii(txt)</code> is
            equivalent to <code>ascii(strcat(txt))</code>.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[ 
ascii(["hello";"world"])
ascii("scilab")
ascii([115 99 105 108 97 98])
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="code2str">code2str</link>
            </member>
            <member>
                <link linkend="str2code">str2code</link>
            </member>
        </simplelist>
    </refsection>
</refentry>