Difference between revisions of "Table.LoadFromBuffer"

From SunFlurry wiki
Jump to: navigation, search
m (1 revision imported)
Line 17: Line 17:
 
== Синтаксис ==
 
== Синтаксис ==
 
<code>
 
<code>
{{Grey|Table.}}'''LoadFromBuffer'''(''<Объект буфера (BUFFER)>''{{Optional|,<Начальная позиция буфера (INT)>{{Default|{{Eq}}0}},<Размер таблицы в буфере (INT)>,<Формат (INT,STRING)>{{Default|{{Eq}}0}}}})
+
{{Grey|Table.}}'''LoadFromBuffer'''(''<Объект буфера (BUFFER)>''{{Optional|,<Начальная позиция буфера (INT)>{{Default|{{Eq}}0}},<Размер таблицы в буфере (INT)>,<Формат (INT,STRING)>,<Индекс или наименование листа (INT,STRING)>}}):''<Наименование загруженного листа (STRING)>''
 
</code>
 
</code>
  
Line 24: Line 24:
 
* <code>''<Начальная позиция буфера (INT)>''</code> - {{Optional}} Аргумент задает начальную позицию таблицы в буфере, если аргумент опущен, загрузка будет начинаться с начала буфера.
 
* <code>''<Начальная позиция буфера (INT)>''</code> - {{Optional}} Аргумент задает начальную позицию таблицы в буфере, если аргумент опущен, загрузка будет начинаться с начала буфера.
 
* <code>''<Размер таблицы в буфере (INT)>''</code> - {{Optional}} Аргумент задает размер таблицы в буфере в байтах, если аргумент опущен, размер будет найден автоматически.
 
* <code>''<Размер таблицы в буфере (INT)>''</code> - {{Optional}} Аргумент задает размер таблицы в буфере в байтах, если аргумент опущен, размер будет найден автоматически.
* <code>''<Формат (INT,STRING)>''</code> - {{Optional}} Аргумент задает формат загружаемого файла в строковом или числовом виде. Доступны следующие значения:
+
* <code>''<Формат (INT,STRING)>''</code> - {{Optional}} Аргумент задает формат загружаемого файла в строковом или числовом виде. Если аргумент опущен, разгрузка будет происходить в формате соответствующем содержимому буфера (формат будет определен автоматически). Доступны следующие значения:
 
** '''0''' или '''SFT''' (по умолчанию) -- файл во внутреннем формате системы (sft)
 
** '''0''' или '''SFT''' (по умолчанию) -- файл во внутреннем формате системы (sft)
 
** '''1''' или '''XLS''' -- файл в формате Excel (xls)
 
** '''1''' или '''XLS''' -- файл в формате Excel (xls)
 
** '''2''' или '''XLSX''' -- {{Planned}} файл в формате Excel (xlsx)
 
** '''2''' или '''XLSX''' -- {{Planned}} файл в формате Excel (xlsx)
 +
* <code>''<Индекс или наименование листа (INT,STRING)>''</code> - {{Optional}} Для форматов, хранящих более одного листа в файле (xls, xlsx), аргумент позволяет указать наименование загружаемого листа (если аргумент представляет строку) или индекс загружаемого листа (если аргумент представляет число, первый лист имеет индекс ''1''). Если аргумент опущен, будет загружен активный лист, либо первый лист, если активный лист недоступен. Если указанный по имени или индексу лист не найден, функция вызовет исключение.
 +
 +
==== Возвращаемое значение ====
 +
Для форматов, хранящих более одного листа в файле (xls, xlsx), функция возвращает наименование загруженного листа, для остальных форматов (stf), будет возвращено пустое значение.
  
 
== Примеры ==
 
== Примеры ==

Revision as of 10:16, 28 February 2021

  LoadFromBuffer (Загрузка таблицы)
Объект:Электронная таблица
Статус разработки: Реализована
Тип:Функция
Обращение к БД:Нет
Исключения:Невозможно превратить в строку, число, неверные аргументы, неверный формат
Визуальность:Нет

Функция производит загрузку текущей таблицы из буфера в указанном формате, предыдущие данные, находившиеся в таблице, будут утеряны.

Синтаксис

Table.LoadFromBuffer(<Объект буфера (BUFFER)>,<Начальная позиция буфера (INT)>=0,<Размер таблицы в буфере (INT)>,<Формат (INT,STRING)>,<Индекс или наименование листа (INT,STRING)>):<Наименование загруженного листа (STRING)>

Аргументы

  • <Объект буфера (BUFFER)> - Аргумент задает объект буфера, откуда будет производиться загрузка таблицы.
  • <Начальная позиция буфера (INT)> - (необязательный аргумент) Аргумент задает начальную позицию таблицы в буфере, если аргумент опущен, загрузка будет начинаться с начала буфера.
  • <Размер таблицы в буфере (INT)> - (необязательный аргумент) Аргумент задает размер таблицы в буфере в байтах, если аргумент опущен, размер будет найден автоматически.
  • <Формат (INT,STRING)> - (необязательный аргумент) Аргумент задает формат загружаемого файла в строковом или числовом виде. Если аргумент опущен, разгрузка будет происходить в формате соответствующем содержимому буфера (формат будет определен автоматически). Доступны следующие значения:
    • 0 или SFT (по умолчанию) -- файл во внутреннем формате системы (sft)
    • 1 или XLS -- файл в формате Excel (xls)
    • 2 или XLSX -- (планируется к реализации) файл в формате Excel (xlsx)
  • <Индекс или наименование листа (INT,STRING)> - (необязательный аргумент) Для форматов, хранящих более одного листа в файле (xls, xlsx), аргумент позволяет указать наименование загружаемого листа (если аргумент представляет строку) или индекс загружаемого листа (если аргумент представляет число, первый лист имеет индекс 1). Если аргумент опущен, будет загружен активный лист, либо первый лист, если активный лист недоступен. Если указанный по имени или индексу лист не найден, функция вызовет исключение.

Возвращаемое значение

Для форматов, хранящих более одного листа в файле (xls, xlsx), функция возвращает наименование загруженного листа, для остальных форматов (stf), будет возвращено пустое значение.

Примеры

//Получение буфера из какого-либо источника (к примеру из обмена TCP/IP)
...

Таб:=Table.Create();
Try
  Таб.LoadFromBuffer(аБуфер,,,"XLS");
Except
  Message(PopError(),"!");
  Message("Полученная таблица имеет неверный формат "+Файл+"! Обратитесь к администратору!","!");
  Exit 0;
EndTry;  
  
If (Trim(Таб.Area(14,1,14,1).Text)<>"")or(Trim(Таб.Area(27,1,27,1).Text)<>"") Then
  Message("Таблица имеет неверный формат!","!");
  Exit 0;  
EndIf;