58e3e4a6d1b8814e9abb502616d5b945deb439d5
[scilab.git] / scilab / modules / fileio / help / ru_RU / mget.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) 2008 - INRIA
5  * ...
6  *
7  * Copyright (C) 2012 - 2016 - Scilab Enterprises
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15  *
16  -->
17 <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="mget" xml:lang="ru">
18     <refnamediv>
19         <refname>mget</refname>
20         <refpurpose>
21             считывает байт или слово в заданном двоичном формате и преобразует в
22             число удвоенной точности
23         </refpurpose>
24     </refnamediv>
25     <refnamediv xml:id="mgeti">
26         <refname>mgeti</refname>
27         <refpurpose>
28             считывает байт или слово в заданном двоичном формате и возвращает
29             целочисленное значение типа int
30         </refpurpose>
31     </refnamediv>
32     <refsynopsisdiv>
33         <title>Синтаксис</title>
34         <synopsis>
35             x = mget([n, type, fd])
36             x = mgeti([n, type, fd])
37         </synopsis>
38     </refsynopsisdiv>
39     <refsection>
40         <title>Аргументы</title>
41         <variablelist>
42             <varlistentry>
43                 <term>n</term>
44                 <listitem>
45                     <para>положительный скаляр: количество считываемых данных.</para>
46                 </listitem>
47             </varlistentry>
48             <varlistentry>
49                 <term>fd</term>
50                 <listitem>
51                     <para>
52                         скаляр: параметр <varname>fd</varname>, возращённый функцией <function>mopen</function>. Для последнего открытого файла ставится -1. Значение по умолчанию -1.
53                     </para>
54                 </listitem>
55             </varlistentry>
56             <varlistentry>
57                 <term>type</term>
58                 <listitem>
59                     <para>
60                         строка: двоичный формат, используемый для записи всех элементов
61                         <varname>x</varname>.
62                     </para>
63                 </listitem>
64             </varlistentry>
65             <varlistentry>
66                 <term>x</term>
67                 <listitem>
68                     <para>
69                         вектор целых чисел или чисел с плавающей запятой.
70                     </para>
71                 </listitem>
72             </varlistentry>
73         </variablelist>
74     </refsection>
75     <refsection>
76         <title>Описание</title>
77         <para>
78             Функция <function>mget</function> считывает данные со входа, определённого параметром потока <varname>fd</varname> и возвращает вектор данных с плавающей запятой.
79         </para>
80
81         <para>
82             Функция <function>mgeti</function> считывает данные со входа, определённого параметром потока <varname>fd</varname> и возвращает вектор целочисленных данных.
83         </para>
84         <para>
85             Данные считываются в положении, на которое в данный момент указывает указатель файла и передвигает индикатор далее соответствующим образом.
86         </para>
87         <para>
88             Параметр <varname>type</varname> является указателем преобразования, который может быть установлен в любой из следующих символов-флагов (со значением по умолчанию <literal>"l"</literal>):
89         </para>
90         <para>
91             <note>
92                 В Windows, поведение по умолчанию состоит в пропуске байта 13 (<literal>0x0D</literal>).
93                 Функцию  <function>mopen</function> следует вызывать с опцией
94                 <literal>'b'</literal>, например, <code>fd1 = mopen(file1,'rb')</code>, так что все байты без исключения будут прочитаны.
95             </note>
96         </para>
97         <para>Тип данных:</para>
98         <variablelist>
99             <varlistentry>
100                 <term>d</term>
101                 <listitem>
102                     <para>удвоенная точность, double</para>
103                 </listitem>
104             </varlistentry>
105             <varlistentry>
106                 <term>f</term>
107                 <listitem>
108                     <para>плавающая запятая, float</para>
109                 </listitem>
110             </varlistentry>
111             <varlistentry>
112                 <term>l</term>
113                 <listitem>
114                     <para>длинное, long long</para>
115                 </listitem>
116             </varlistentry>
117             <varlistentry>
118                 <term>i</term>
119                 <listitem>
120                     <para>целочисленное, int (long int)</para>
121                 </listitem>
122             </varlistentry>
123             <varlistentry>
124                 <term>s</term>
125                 <listitem>
126                     <para>короткое, short</para>
127                 </listitem>
128             </varlistentry>
129             <varlistentry>
130                 <term>c</term>
131                 <listitem>
132                     <para>символ, character</para>
133                 </listitem>
134             </varlistentry>
135         </variablelist>
136         <para>Необязательный флаг:</para>
137         <variablelist>
138             <varlistentry>
139                 <term>u..</term>
140                 <listitem>
141                     <para>
142                         беззнаковый (в сочетании с одним из вышеперечисленных типов)
143                     </para>
144                 </listitem>
145             </varlistentry>
146             <varlistentry>
147                 <term>..l</term>
148                 <listitem>
149                     <para>
150                         прямой порядок байтов (в сочетании с одним из вышеперечисленных
151                         типов)
152                     </para>
153                 </listitem>
154             </varlistentry>
155             <varlistentry>
156                 <term>..b</term>
157                 <listitem>
158                     <para>
159                         обратный порядок байтов (в сочетании с одним из вышеперечисленных
160                         типов)
161                     </para>
162                 </listitem>
163             </varlistentry>
164         </variablelist>
165         <para>
166             Чтение байтов автоматически переключается при необходимости (с помощью проверки статуса <literal>little=endian</literal>).
167         </para>
168         <para>
169             Такое поведение переключения можно подавить, если добавить флаг в функцию <function>mopen</function>.
170         </para>
171         <para>
172             Форматы <literal>"l"</literal>, <literal>"d"</literal> и
173             <literal>"f"</literal> корректны только с функцией
174             <function>mget</function>.
175         </para>
176     </refsection>
177     <refsection>
178         <title>Примеры</title>
179         <programlisting role="example"><![CDATA[
180 file1 = fullfile(TMPDIR,'test1.bin');
181 file2 = fullfile(TMPDIR,'test2.bin');
182 fd1=mopen(file1,'wb');
183 fd2=mopen(file2,'wb');
184 mput(1996,'ull',fd1);
185 mput(1996,'ull',fd2);
186 mclose(fd1);
187 mclose(fd2);
188
189 fd1=mopen(file1,'rb');
190 if 1996<>mget(1,'ull',fd1)
191   write(%io(2),'Bug');
192 end
193
194 fd2=mopen(file2,'rb');
195 if 1996<>mget(1,'ull',fd2)
196   write(%io(2),'Bug');
197 end
198
199 mclose(fd1);
200 mclose(fd2);
201  ]]></programlisting>
202     </refsection>
203     <refsection role="see also">
204         <title>Смотрите также</title>
205         <simplelist type="inline">
206             <member>
207                 <link linkend="mclose">mclose</link>
208             </member>
209             <member>
210                 <link linkend="meof">meof</link>
211             </member>
212             <member>
213                 <link linkend="mfprintf">mfprintf</link>
214             </member>
215             <member>
216                 <link linkend="fprintfMat">fprintfMat</link>
217             </member>
218             <member>
219                 <link linkend="mfscanf">mfscanf</link>
220             </member>
221             <member>
222                 <link linkend="fscanfMat">fscanfMat</link>
223             </member>
224             <member>
225                 <link linkend="mgetl">mgetl</link>
226             </member>
227             <member>
228                 <link linkend="mgetstr">mgetstr</link>
229             </member>
230             <member>
231                 <link linkend="mopen">mopen</link>
232             </member>
233             <member>
234                 <link linkend="mprintf">mprintf</link>
235             </member>
236             <member>
237                 <link linkend="mput">mput</link>
238             </member>
239             <member>
240                 <link linkend="mputl">mputl</link>
241             </member>
242             <member>
243                 <link linkend="mputstr">mputstr</link>
244             </member>
245             <member>
246                 <link linkend="mseek">mseek</link>
247             </member>
248             <member>
249                 <link linkend="mtell">mtell</link>
250             </member>
251             <member>
252                 <link linkend="mdelete">mdelete</link>
253             </member>
254         </simplelist>
255     </refsection>
256 </refentry>
257