License Header change: Removed the LICENSE_END before beta
[scilab.git] / scilab / modules / api_scilab / help / en_US / legacy / string / F_freeAllocatedMatrixOfString.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) 2009  - DIGITEO - Antoine ELIAS
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="freeAllocatedMatrixOfString" xml:lang="en">
17     <refnamediv>
18         <refname>freeAllocatedMatrixOfString</refname>
19         <refpurpose>
20             Free memory allocated by getAllocatedMatrixOfString function.
21         </refpurpose>
22     </refnamediv>
23     <refsynopsisdiv>
24         <title>Calling Sequence</title>
25         <synopsis>
26             void freeAllocatedMatrixOfString(int _iRows, int _iCols, char** _pstData)
27             void freeAllocatedMatrixOfWideString(int _iRows, int _iCols, wchar_t** _pwstData)
28         </synopsis>
29     </refsynopsisdiv>
30     <refsection>
31         <title>Arguments</title>
32         <variablelist>
33             <varlistentry>
34                 <term>_iRows</term>
35                 <listitem>
36                     <para>
37                         Value "_piRows" returns by freeAllocatedMatrixOfString.
38                     </para>
39                 </listitem>
40             </varlistentry>
41             <varlistentry>
42                 <term>_iCols</term>
43                 <listitem>
44                     <para>
45                         Value "_piCols" returns by freeAllocatedMatrixOfString.
46                     </para>
47                 </listitem>
48             </varlistentry>
49             <varlistentry>
50                 <term>_pstData</term>
51                 <listitem>
52                     <para>
53                         Pointer "_pstData" allocated by freeAllocatedMatrixOfString.
54                     </para>
55                 </listitem>
56             </varlistentry>
57             <varlistentry>
58                 <term>_pwstData</term>
59                 <listitem>
60                     <para>
61                         Pointer "_pwstData" allocated by freeAllocatedWideMatrixOfString.
62                     </para>
63                 </listitem>
64             </varlistentry>
65         </variablelist>
66     </refsection>
67 </refentry>