License Header change: Removed the LICENSE_END before beta
[scilab.git] / scilab / modules / api_scilab / help / ja_JP / legacy / polynomial / E_getAllocatedMatrixOfComplexPoly.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="getAllocatedMatrixOfComplexPoly" xml:lang="ja">
17     <refnamediv>
18         <refname>getAllocatedMatrixOfComplexPoly</refname>
19         <refpurpose>
20             複素数多項式変数の行列を取得.
21         </refpurpose>
22     </refnamediv>
23     <refsynopsisdiv>
24         <title>呼び出し手順</title>
25         <synopsis>int getAllocatedMatrixOfComplexPoly(void* _pvCtx, int* _piAddress, int* _piRows, int* _piCols, int** _piNbCoef, double*** _pdblReal, double*** _pdblImg)</synopsis>
26         <synopsis>int getAllocatedNamedMatrixOfComplexPoly(void* _pvCtx, const char* _pstName, int* _piRows, int* _piCols, int** _piNbCoef, double*** _pdblReal, double*** _pdblImg)</synopsis>
27     </refsynopsisdiv>
28     <refsection>
29         <title>引数</title>
30         <variablelist>
31             <varlistentry>
32                 <term>_pvCtx</term>
33                 <listitem>
34                     <para>
35                         Scilab環境ポインタ, api_scilab.hで定義された"pvApiCtx"で指定.
36                     </para>
37                 </listitem>
38             </varlistentry>
39             <varlistentry>
40                 <term>_piAddress</term>
41                 <listitem>
42                     <para>
43                         Scilab変数のアドレス.
44                     </para>
45                 </listitem>
46             </varlistentry>
47             <varlistentry>
48                 <term>_pstName</term>
49                 <listitem>
50                     <para>
51                         "名前指定" 関数の変数名.
52                     </para>
53                 </listitem>
54             </varlistentry>
55             <varlistentry>
56                 <term>_piRows</term>
57                 <listitem>
58                     <para>
59                         返される行数.
60                     </para>
61                 </listitem>
62             </varlistentry>
63             <varlistentry>
64                 <term>_piCols</term>
65                 <listitem>
66                     <para>
67                         返される列数.
68                     </para>
69                 </listitem>
70             </varlistentry>
71             <varlistentry>
72                 <term>_piNbCoef</term>
73                 <listitem>
74                     <para>
75                         返される各多項式の係数の数. (メモリ確保が必要)
76                     </para>
77                 </listitem>
78             </varlistentry>
79             <varlistentry>
80                 <term>_pdblReal</term>
81                 <listitem>
82                     <para>
83                         返される係数の実部の配列.
84                     </para>
85                 </listitem>
86             </varlistentry>
87             <varlistentry>
88                 <term>_pdblImg</term>
89                 <listitem>
90                     <para>
91                         返される係数の虚部の配列.
92                     </para>
93                 </listitem>
94             </varlistentry>
95         </variablelist>
96     </refsection>
97     <refsection>
98         <title>戻り値</title>
99         <para>成功した場合に 0, それ以外はエラーメッセージへのScilabコンソールに出力し,
100             最初のエラー番号を返します.
101         </para>
102     </refsection>
103 </refentry>