62371ca1c2b9dc3637792ac3ee34575aa572212f
[scilab.git] / scilab / modules / api_scilab / help / ja_JP / handle / B_getScalarHandle.xml
1 <?xml version="1.0" encoding="utf-8"?>
2
3 <!--
4  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
5  * Copyright (C) 2009  - DIGITEO - Antoine ELIAS
6  * 
7  * This file must be used under the terms of the CeCILL.
8  * This source file is licensed as described in the file COPYING, which
9  * you should have received as part of this distribution.  The terms
10  * are also available at    
11  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
12  *
13  -->
14
15 <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="getScalarHandle" xml:lang="ja">
16     
17     <refnamediv>
18         
19         <refname>getScalarHandle</refname>
20         
21         <refpurpose>
22             
23             ゲートウェイ引数からスカラーハンドルデータを読み込む.
24             
25         </refpurpose>
26         
27     </refnamediv>
28     
29     <refsynopsisdiv>
30         
31         <title>呼び出し手順</title>
32         
33         <synopsis>int getScalarHandle(void* _pvCtx, int* _piAddress, long long* _pllHandle)</synopsis>
34         
35     </refsynopsisdiv>
36     
37     <refsection>
38         
39         <title>引数</title>
40         
41         <variablelist>
42             
43             <varlistentry>
44                 
45                 <term>_pvCtx</term>
46                 
47                 <listitem>
48                     
49                     <para>
50                         
51                         Scilab環境ポインタ, api_scilab.h により定義された "pvApiCtx"で指定.
52                         
53                     </para>
54                     
55                 </listitem>
56                 
57             </varlistentry>
58             
59             <varlistentry>
60                 
61                 <term>_piAddress</term>
62                 
63                 <listitem>
64                     
65                     <para>
66                         
67                         Scilab変数のアドレス.
68                         
69                     </para>
70                     
71                 </listitem>
72                 
73             </varlistentry>
74             
75             <varlistentry>
76                 
77                 <term>_pllHandle</term>
78                 
79                 <listitem>
80                     
81                     <para>
82                         
83                         返されるハンドル値.
84                         
85                     </para>
86                     
87                 </listitem>
88                 
89             </varlistentry>
90             
91         </variablelist>
92         
93     </refsection>
94     
95     <refsection>
96         
97         <title>戻り値</title>
98         
99         <para>成功した場合は 0, それ以外はScilabコンソールにエラーメッセージを出力し,
100             
101             最初のエラー番号を返します.
102         </para>
103         
104     </refsection>
105     
106     <title>履歴</title>
107     
108     <revhistory>
109         
110         <revision>
111             
112             <revnumber>5.5.0</revnumber>
113             
114             <revremark>この関数はScilab 5.5.0で追加されました</revremark>
115             
116         </revision>
117         
118     </revhistory>
119     
120 </refentry>
121