License Header change: Removed the LICENSE_END before beta
[scilab.git] / scilab / modules / api_scilab / help / ja_JP / legacy / string / B_getAllocatedSingleString.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="getAllocatedSingleString" xml:lang="ja">
17     <refnamediv>
18         <refname>getAllocatedSingleString</refname>
19         <refpurpose>
20             文字列変数を1つ取得.
21         </refpurpose>
22     </refnamediv>
23     <refsynopsisdiv>
24         <title>呼び出し手順</title>
25         <synopsis>int getAllocatedSingleString(void* _pvCtx, int* _piAddress, char** _pstData)</synopsis>
26         <synopsis>int getAllocatedNamedSingleString(void* _pvCtx, const char* _pstName, char** _pstData)</synopsis>
27         <synopsis>int getAllocatedSingleWideString(void* _pvCtx, int* _piAddress, wchar_t** _pwstData)</synopsis>
28         <synopsis>int getAllocatedNamedSingleWideString(void* _pvCtx, const char* _pstName, wchar_t** _pwstData)</synopsis>
29     </refsynopsisdiv>
30     <refsection>
31         <title>引数</title>
32         <variablelist>
33             <varlistentry>
34                 <term>_pvCtx</term>
35                 <listitem>
36                     <para>
37                         Scilab環境ポインタ, api_scilab.hで提供される"pvApiCtx"を指定.
38                     </para>
39                 </listitem>
40             </varlistentry>
41             <varlistentry>
42                 <term>_piAddress</term>
43                 <listitem>
44                     <para>
45                         Scilab変数のアドレス.
46                     </para>
47                 </listitem>
48             </varlistentry>
49             <varlistentry>
50                 <term>_pstName</term>
51                 <listitem>
52                     <para>
53                         "名前指定" 関数の場合の変数名.
54                     </para>
55                 </listitem>
56             </varlistentry>
57             <varlistentry>
58                 <term>_pstData</term>
59                 <listitem>
60                     <para>
61                         戻り値の文字列のアドレス.
62                     </para>
63                 </listitem>
64             </varlistentry>
65             <varlistentry>
66                 <term>_pwstData</term>
67                 <listitem>
68                     <para>
69                         戻り値のワイド文字列のアドレス.
70                     </para>
71                 </listitem>
72             </varlistentry>
73         </variablelist>
74     </refsection>
75     <refsection>
76         <title>戻り値</title>
77         <para>
78             成功した場合は 0, それ以外はScilabコンソールにエラーメッセージを表示し,
79             最初のエラー番号を返します.
80         </para>
81     </refsection>
82 </refentry>