Admin: /* Атрибуты и функции */

2020-07-23T15:30:48Z

‎Атрибуты и функции

New page

{{infobox object
|object=DBF
|status=2
|create=[[DBF.Create|Create]]}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]}}
Объект '''внешняя таблица DBF''' позволяет получить быстрый доступ к данным во внешних файлах .dbf, а также создавать новые файл DBF, удалять записи в них, добавлять или удалять отдельные поля и пр. Объект используется для выгрузки или загрузки данных из приложений, по-прежнему использующих этот формат, для создания новых интерфейсов обмена рекомендуется использование более простых текстовых или xml файлов. К ограничениям формата относится максимальный размер наименования его поля (всего 10 байт), невозможность использования для данных или наименований полей Unicode (наименования полей желательно записывать в латинском алфавите в верхнем регистре для того, чтобы избежать проблем с совместимостью со старыми программами). Для работы с объектом после его создания можно открыть внешний файл ([[DBF.Open|Open]]) и получить информацию из него ([[DBF.Select|Select]], [[DBF.Next|Next]]), либо, для новых файлов, изменить имя файла (чтобы объект считал, что файл открыт), выбрать необходимую кодовую страницу, добавить нужные поля, и сохранить файл. Пример создания и заполнения нового файла:

<pre>
//Создадим новый файл с именем ИмяФайла для выгрузки продаж
бРез:=dbf.Create();
бРез.FileName:=ИмяФайла;
//Используем кодировку: кириллица OEM
бРез.CodePage:=866;
бРез.AddField(,"DATE","DATE");
бРез.AddField(,"NUMBER","STRING.20");
бРез.AddField(,"POINTCODE","STRING.20");
бРез.AddField(,"POINT","STRING.200");
бРез.AddField(,"NOMCODE","STRING.10");
бРез.AddField(,"NOMNAME","STRING.60");
бРез.AddField(,"NOMCOEFF","NUMBER.5.0");
бРез.AddField(,"AMOUNT","NUMBER.10.0");
бРез.AddField(,"PRICE","NUMBER.15.2");
бРез.AddField(,"SUM","NUMBER.15.2");

//Выгрузим строки строчной части Номенклатура в созданный файл
зАД:=aEl.ТорговаяТочка;
aTab:=aEl.LineParts("Номенклатура");
aTab.Select();
While aTab.Next() Do
If aTab.Количество=0 Then
Continue;
EndIf;
зН:=aTab.Номенклатура;
//Добавим новую запись
бРез.AddRecord(,"DATE,NUMBER,POINTCODE,POINT,NOMCODE,NOMNAME,NOMCOEFF,AMOUNT,PRICE,SUM",
aEl.DocDate,aEl.DocNum,зАД.Code,зАД,зН.Code,зН.Name,зН.Коэффициент,aTab.Количество,Round(aTab.Сумма/aTab.Количество,2),aTab.Сумма);
EndDo;
//Сохраним и закроем файл
бРез.Save();
бРез.Close();
</pre>

== Атрибуты и функции==
{{function header}}
{{function entry
|name=[[DBF.Create|Create]]
|form={{Grey|DBF.}}'''Create'''():''<Новый объект (DBF)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает новый объект типа [[Внешняя таблица DBF]]
}}
{{function entry
|name=[[DBF.FileOpen|FileOpen]]
|form={{Grey|DBF.}}'''FileOpen''':''<DBF-файл открыт (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут проверяет, задан ли файл для текущего объекта. Атрибут возвращает 1 если файл был загружен (он существовал раньше), либо задано имя файла, но таблица новая, и еще ни разу не сохранялась.
}}
{{function entry
|name=[[DBF.Codepage|Codepage]]
|form={{Grey|DBF.}}'''Codepage''':''<Кодовая страница данных файла (INT)>''
|type=0
|status=2
|visual=0
|description=Получить кодовую страницу файла, либо установить ее в заголовок файла (при этом сами данные в файле не будут перекодированы -- используется для открытия неверно созданных файлов, для перекодировки данных используйте [[DBF.TranslateTo|TranslateTo]]).
}}
{{function entry
|name=[[DBF.LoadInMemory|LoadInMemory]]
|form={{Grey|DBF.}}'''LoadInMemory''':''<Загружать файл полностью или читать по записям с диска (INT)>''
|type=0
|status=0
|visual=0
|description=Получить или изменить режим открытия файла. По умолчанию файл полностью загружается в память, что сильно ускоряет работу с ним. Опция может изменить режим, в память будут загружены только отдельные записи, что может быть полезно для очень больших файлов.
}}
{{function entry
|name=[[DBF.FileName|FileName]]
|form={{Grey|DBF.}}'''FileName''':''<Имя открытого или создаваемого файла (STRING)>''
|type=0
|status=2
|visual=0
|description=Получить или изменить имя открытого в данный момент файла. Имя задается с путем к файлу и расширением. Если при изменении имени файл существует, файл будет автоматически открыт.
}}
{{function entry
|name=[[DBF.CurRecord|CurRecord]]
|form={{Grey|DBF.}}'''CurRecord''':''<Индекс текущей записи (INT)>''
|type=0
|status=2
|visual=0
|description=Получает индекс текущей открытой записи. Если запись новая, атрибут возвращает -1, если позиционирование на запись не производилось, атрибут возвращает 0.
}}
{{function entry
|name=[[DBF.IsDeleted|IsDeleted]]
|form={{Grey|DBF.}}'''IsDeleted''':''<Текущая запись удалена (INT)>''
|type=0
|status=2
|visual=0
|description=Получить или изменить статус удаления текущей позиционированной или новой записи.
}}
{{function entry
|name=[[DBF.Fields|Fields]]
|form={{Grey|DBF.}}'''Fields''':''<Количество полей в файле (INT)>''
|type=0
|status=2
|visual=0
|description=Атрибут возвращает количество полей в текущем файле
}}
{{function entry
|name=[[DBF.FieldNameA|<Имя поля>]]
|form={{Grey|DBF.}}'''<Имя поля>''':''<Значение поля>''
|type=0
|status=2
|visual=0
|description=Получить или изменить значение поля с именем ''<Имя поля>'' для текущей позиционированной или созданной строки. '''Внимание!''' Поиск имен полей ведется без учета регистра, если в таблице существуют поля, имена которых отличаются только регистром, необходимо использовать функции [[DBF.GetValue|GetValue]] или [[DBF.SetValue|SetValue]].
}}
{{function entry
|name=[[DBF.Open|Open]]
|form={{Grey|DBF.}}'''Open'''(''<Имя файла (STRING)>'')
|type=1
|status=2
|visual=0
|description=Функция закрывает ранее открытый файл, если таковой был, и открывает указанный
}}
{{function entry
|name=[[DBF.Save|Save]]
|form={{Grey|DBF.}}'''Save'''()
|type=1
|status=2
|visual=0
|description=Функция сохраняет все изменения, произведенные в открытом файле (т.е., сохраняет на диск все данные файла и, если необходимо, его заголовок).
}}
{{function entry
|name=[[DBF.SaveRecord|SaveRecord]]
|form={{Grey|DBF.}}'''SaveRecord'''({{Optional|<Сохранить изменения (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=0
|description=Функция сохраняет изменения в текущей записи (при этом сама запись не будет записана на диск, без дополнительного параметра).
}}
{{function entry
|name=[[DBF.Close|Close]]
|form={{Grey|DBF.}}'''Close'''()
|type=1
|status=2
|visual=0
|description=Функция закрывает текущий рабочий файл, удаляя из него все записи. Все несохраненные изменения будут утеряны.
}}
{{function entry
|name=[[DBF.Pack|Pack]]
|form={{Grey|DBF.}}'''Pack'''()
|type=1
|status=0
|visual=0
|description=Функция удаляет из текущего файла все записи, помеченные на удаление.
}}
{{function entry
|name=[[DBF.AddField|AddField]]
|form={{Grey|DBF.}}'''AddField'''({{Optional|<Индекс нового поля (INT)>,}}''<Наименование нового поля (STRING)>'',''<Тип данных нового поля (STRING)>'')
|type=1
|status=2
|visual=0
|description=Функция добавляет новое поле в текущий файл. Если в файле существуют записи, новое поле будет заполнено пустыми значениями.
}}
{{function entry
|name=[[DBF.RemoveField|RemoveField]]
|form={{Grey|DBF.}}'''RemoveField'''(''<Индекс или наименование поля (INT,STRING)>'')
|type=1
|status=0
|visual=0
|description=Функция удаляет поле из текущего файла.
}}
{{function entry
|name=[[DBF.FieldName|FieldName]]
|form={{Grey|DBF.}}'''FieldName'''(''<Индекс поля (INT)>''):''<Наименование поля (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция получает наименование поля по его индексу.
}}
{{function entry
|name=[[DBF.FieldIndex|FieldIndex]]
|form={{Grey|DBF.}}'''FieldIndex'''(''<Наименование поля (STRING)>''):''<Индекс поля (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает индекс поля по его наименованию.
}}
{{function entry
|name=[[DBF.FieldDataType|FieldDataType]]
|form={{Grey|DBF.}}'''FieldDataType'''(''<Наименование или индекс поля (INT,STRING)>''):''<Тип данных поля (STRING)>''
|type=1
|status=0
|visual=0
|description=Функция получает тип данных поля по его наименованию или индексу.
}}
{{function entry
|name=[[DBF.Clear|Clear]]
|form={{Grey|DBF.}}'''Clear'''()
|type=1
|status=2
|visual=0
|description=Функция удаляет все записи и все поля из текущего файла.
}}
{{function entry
|name=[[DBF.ClearRecords|ClearRecords]]
|form={{Grey|DBF.}}'''ClearRecords'''()
|type=1
|status=2
|visual=0
|description=Функция удаляет все записи из текущего файла, при этом его поля остаются без изменения.
}}
{{function entry
|name=[[DBF.RemoveRecords|RemoveRecords]]
|form={{Grey|DBF.}}'''RemoveRecords'''({{Optional|<Фильтры поиска записей>...,<Наименование используемого индекса (STRING)>}})
|type=1
|status=0
|visual=0
|description=Функция физически удаляет записи, входящие в фильтр, из текущего файла.
}}
{{function entry
|name=[[DBF.RecordsNumber|RecordsNumber]]
|form={{Grey|DBF.}}'''RecordsNumber'''({{Optional|<Фильтры поиска записей>...,<Наименование используемого индекса (STRING)>}}):''<Количество записей (INT)>''
|type=1
|status=0
|visual=0
|description=Функция возвращает количество записей, входящих в заданный фильтр.
}}
{{function entry
|name=[[DBF.LoadRecords|LoadRecords]]
|form={{Grey|DBF.}}'''LoadRecords'''({{Optional|<Макс. количество записей для загрузки (INT)>{{Default|{{Eq}}0}},<Фильтры поиска записей>...,<Наименование используемого индекса (STRING)>}}):''<Загруженные записи (TAB)>''
|type=1
|status=0
|visual=0
|description=Функция загружает в таблицу значений записи файла, входящие в заданный фильтр.
}}
{{function entry
|name=[[DBF.CopyFrom|CopyFrom]]
|form={{Grey|DBF.}}'''CopyFrom'''(''<Таблица из которой происходит копирование (TAB)>''{{Optional|,<Начальная позиция таблицы (INT)>{{Default|{{Eq}}0}},<Количество записей для копирования (INT)>}})
|type=1
|status=0
|visual=0
|description=Функция копирует требуемый диапазон строк из таблицы значений в файл. Наименования столбцов для копирования должны соответствовать наименованиям полей файла.
}}
{{function entry
|name=[[DBF.AddRecord|AddRecord]]
|form={{Grey|DBF.}}'''AddRecord'''({{Optional|<Индекс записи (INT)>{{Default|{{Eq}}0}},<Наименования полей (STRING)>,<Значение поля 1>,<Значение поля 2>...}})
|type=1
|status=2
|visual=0
|description=Функция добавляет (или вставляет) новую запись в текущий файл и заполняет указанные поля записи указанными значениями. Запись становится текущей, остальные поля можно заполнить позже. До изменения текущей записи, предыдущая будет автоматически сохранена (т.е., будет выполнена функция <code><DBF>.SaveRecord(0)</code>, если было позиционирование на предыдущей записи). Внимание! Поиск имен полей производится с учетом регистра! При указании имени необходимо соблюдать корректный регистр букв имени поля!
}}
{{function entry
|name=[[DBF.Get|Get]]
|form={{Grey|DBF.}}'''Get'''(''<Индекс записи (INT)>'',''<Индекс или наименование поля (INT,STRING)>''):''<Значение поля>''
|type=1
|status=0
|visual=0
|description=Функция получает значение указанного поля в произвольной записи файла
}}
{{function entry
|name=[[DBF.Set|Set]]
|form={{Grey|DBF.}}'''Set'''(''<Индекс записи (INT)>'',''<Индекс или наименование поля (INT,STRING)>'',''<Значение поля>'')
|type=1
|status=0
|visual=0
|description=Функция изменяет значение указанного поля в произвольной записи файла
}}
{{function entry
|name=[[DBF.GetValue|GetValue]]
|form={{Grey|DBF.}}'''GetValue'''(''<Индекс или наименование поля (INT,STRING)>''):''<Значение поля>''
|type=1
|status=2
|visual=0
|description=Функция получает значение поля текущей записи по его имени или индексу. Внимание! Поиск имен полей производится с учетом регистра! При указании имени необходимо соблюдать корректный регистр букв имени поля!
}}
{{function entry
|name=[[DBF.SetValue|SetValue]]
|form={{Grey|DBF.}}'''SetValue'''(''<Индекс или наименование поля (INT,STRING)>'',''<Значение поля>'')
|type=1
|status=2
|visual=0
|description=Функция изменяет значение поля текущей записи по его имени или индексу. Внимание! Поиск имен полей производится с учетом регистра! При указании имени необходимо соблюдать корректный регистр букв имени поля!
}}
{{function entry
|name=[[DBF.TranslateTo|TranslateTo]]
|form={{Grey|DBF.}}'''TranslateTo'''(''<Кодовая страница (INT)>'')
|type=1
|status=0
|visual=0
|description=Функция преобразует текстовые данные во всем файле в новую кодовую страницу. Заголовок файла будет модифицирован соответствующим образом.
}}
{{function entry
|name=[[DBF.OpenIndexFile|OpenIndexFile]]
|form={{Grey|DBF.}}'''OpenIndexFile'''(''<Имя файла индекса (STRING)>'')
|type=1
|status=0
|visual=0
|description=Функция добавляет указанный файл индекса к текущим открытым индексам файла
}}
{{function entry
|name=[[DBF.IndexCount|IndexCount]]
|form={{Grey|DBF.}}'''IndexCount'''():''<Количество открытых индексов (INT)>''
|type=1
|status=0
|visual=0
|description=Функция получает количество загруженных в данный момент индексов
}}
{{function entry
|name=[[DBF.CloseIndexFile|CloseIndexFile]]
|form={{Grey|DBF.}}'''CloseIndexFile'''(''<Имя индекса (STRING)>'')
|type=1
|status=0
|visual=0
|description=Функция закрывает указанный индекс файла (индексы именуются по именам их файлов без расширений).
}}
{{function entry
|name=[[DBF.CreateIndex|CreateIndex]]
|form={{Grey|DBF.}}'''CreateIndex'''(''<Путь и имя файла индекса (STRING)>'',''<Имена полей идекса с направлениями сортировки (STRING)>'')
|type=1
|status=0
|visual=0
|description=Функция создает и заполняет новый индекс с указанным именем файла
}}
{{function entry
|name=[[DBF.First|First]]
|form={{Grey|DBF.}}'''First'''()
|type=1
|status=2
|visual=0
|description=Функция перемещает текущий курсор позиционирования вне записей файла (текущая запись не будет позиционированной)
}}
{{function entry
|name=[[DBF.Select|Select]]
|form={{Grey|DBF.}}'''Select'''({{Optional|<Фильтры поиска записей>...,<Наименование используемого индекса (STRING)>}}):''<Найдена по крайней мере одна запись (INT)>''
|type=1
|status=1
|visual=0
|description=Функция открывает выборку в файле, которая будет получать записи с указанным фильтром.
}}
{{function entry
|name=[[DBF.Next|Next]]
|form={{Grey|DBF.}}'''Next'''():''<Следующая запись найдена (INT)>''
|type=1
|status=2
|visual=0
|description=Функция получает следующую запись выборки. Если запись найдена, функция возвращает 1, иначе 0.
}}
{{function entry
|name=[[DBF.Goto|Goto]]
|form={{Grey|DBF.}}'''Goto'''(''<Индекс записи файла (INT)>'')
|type=1
|status=2
|visual=0
|description=Функция перемещает текущую запись внутри файла.
}}
{{function entry
|name=[[DBF.Mark|Mark]]
|form={{Grey|DBF.}}'''Mark'''({{Optional|<Установить пометку удаления (1), снять (0) (INT)>,<Индекс записи (INT)>{{Default|{{Eq}}0}},<Сохранить изменения (INT)>{{Default|{{Eq}}0}}}})
|type=1
|status=2
|visual=0
|description=Функция устанавливает или снимает на требуемой или текущей записи признак удаления. Функция также может сохранить текущие изменения файла.
}}
{{function entry
|name=[[DBF.RereadRecord|RereadRecord]]
|form={{Grey|DBF.}}'''RereadRecord'''()
|type=1
|status=2
|visual=0
|description=Функция перечитывает текущую запись из памяти, все изменения произведенные в текущей записи будут утеряны.
}}
{{function footer}}

{{Объекты}}

Внешняя таблица DBF - Revision history

Admin: 1 revision imported

Admin: /* Атрибуты и функции */

← Older revision	Revision as of 06:54, 7 February 2021
(No difference)