Справочник функций пакета BTRV

Справочник функций пакета BTRV_UTL

function Open(fh in out varchar2,filename varchar2) return pls_integer

Функция открывает файл Btrieve, после чего становится возможно его использовать. Функции необходимо передать переменную типа VARCHAR2(141), которая будет использоваться в дальнейшем в качестве дескриптора открытого файла Btrieve.
Внимание! Переменная должна быть инициализирована до вызова Open. Рекомендуется использование в качестве значения для инициализации выражения rpad(' ',141) .
Вторым параметром передается полный путь к файлу Btrieve. Если файл лежит на сервере NetWare, который подключен к серверу(где установлен Oracle) по NFS, то полный путь имеет вид NFS_directory/NW_volume/path

Пример:

declare
    fh varchar2(141):=rpad(' ',141);
    status pls_integer;
begin
    status:=btrv_utl.Open(fh,'/NW_server/pupsik/bank/account.dat');
end;

function Close(fh in out varchar2) return pls_integer

Функция закрывает файл Btrieve, в результате чего освобождаются ресурсы на сервере. Необходимо, вызывать Close для каждого ранее открытого файла Btrieve, после того как работа с ним закончена!

Пример:

declare
    fh varchar2(141):=rpad(' ',141);
    status pls_integer;
begin
    status:=btrv_utl.Open(fh,'/NW_server/pupsik/bank/account.dat');
    status:=btrv_utl.Close(fh);
end;

function GetStatus return pls_integer

Функция возвращает статус последней вызванной операции Btrieve. В случае успеха Btrieve всегда возвращает 0. Коды завершения операций Btrieve можно посмотреть в документации по Btrieve или Pervasive SQL. Чтобы получить текстовое описание статуса последней вызванной операции Btrieve, Вы можете использовать функцию GetMessage пакета BTRV_UTL.

function GetMessage return varchar2

Функция возвращает текстовое описание статуса последней вызванной операции Btrieve.

procedure StepFirst(fh in out varchar2)

Функция переходит на первую запись в физическом порядке следования в заданном открытом файле Btrieve.

Пример:

declare
    fh varchar2(141):=rpad(' ',141);
    status pls_integer;
begin
    status:=btrv_utl.Open(fh,'/NW_server/pupsik/bank/account.dat');
    btrv_utl.StepFirst(fh);
    if btrv_utl.GetStatus=0 then
        dbms_output.put_line('We are get the first record');
    else
        dbms_output.put_line('Error code='||to_char(btrv_utl.GetStatus)||' '||btrv_utl.GetMessage);
    end if;
    status:=btrv_utl.Close(fh);
end;
procedure StepNext(fh in out varchar2)

Функция переходит на следующую запись в физическом порядке следования в заданном открытом файле Btrieve.

Пример:

declare
    fh varchar2(141):=rpad(' ',141);
    status pls_integer;
    counter pls_integer;
begin
    status:=btrv_utl.Open(fh,'/NW_server/pupsik/bank/account.dat');
    btrv_utl.StepFirst(fh);
    if btrv_utl.GetStatus=0 then
        dbms_output.put_line('We are get the first record');
    else
        dbms_output.put_line('Error code='||to_char(btrv_utl.GetStatus)||' '||btrv_utl.GetMessage);
    end if;
    counter:=0;
    while btrv_utl.GetStatus=0 loop
        counter:=counter+1;
        btrv_utl.StepNext(fh);
    end loop;
    dbms_output.put_line('The file contains '||to_char(counter)||' records');
    status:=btrv_utl.Close(fh);
end;
procedure StepLast(fh in out varchar2)

Функция переходит на последнюю запись в физическом порядке следования в заданном открытом файле Btrieve.

Пример:

declare
    fh varchar2(141):=rpad(' ',141);
    status pls_integer;
    counter pls_integer;
begin
    status:=btrv_utl.Open(fh,'/NW_server/pupsik/bank/account.dat');
    btrv_utl.StepLast(fh);
    if btrv_utl.GetStatus=0 then
        dbms_output.put_line('We are get the last record');
    else
        dbms_output.put_line('Error code='||to_char(btrv_utl.GetStatus)||' '||btrv_utl.GetMessage);
    end if;
    counter:=0;
    while btrv_utl.GetStatus=0 loop
        counter:=counter+1;
        btrv_utl.StepPrev(fh);
    end loop;
    dbms_output.put_line('The file contains '||to_char(counter)||' records');
    status:=btrv_utl.Close(fh);
end;
procedure StepPrev(fh in out varchar2)

Функция переходит на предыдущую запись в физическом порядке следования в заданном открытом файле Btrieve.
procedure GetEq(fh in out varchar2)

Функция выполняет поиск в заданном открытом файле Btrieve по точному совпадению с выражением для поиска (ключом). Поиск ведется по индексу. Нужный индекс должен быть заранее выбран при помощи функции SetKeyNum(). Ключ(выражение для поиска) задается при помощи процедур AddKey...(). После завершения поиска, независимо от результата, выражение для поиска(ключ) обнуляется!

Пример:

-- Необходимо найти счет открытый 12/05/2004 оператором #34
-- В account.btr есть индекс #1 по date_open+user_id
declare
    fh varchar2(141):=rpad(' ',141);
    status pls_integer;
    counter pls_integer;
begin
    status:=btrv_utl.Open(fh,'/NW_server/pupsik/bank/account.dat');
    btrv_utl.SetKeyNum(fh,1);
    btrv_utl.AddKeyDate(fh,'20040512');
    btrv_utl.AddKeyShort(fh,34);
    btrv_utl.GetEq(fh);
    if btrv_utl.GetStatus=0 then
        dbms_output.put_line('Account='||btrv_utl.GetString(fh,4,20));
    else
        dbms_output.put_line('Account not found');
    end if;

    status:=btrv_utl.Close(fh);
end;
procedure GetGe(fh in out varchar2)

Функция выполняет поиск в заданном открытом файле Btrieve по условию значение ключа в индексе >= выражение для поиска (ключ). Поиск ведется по индексу. Нужный индекс должен быть заранее выбран при помощи функции SetKeyNum(). Ключ(выражение для поиска) задается при помощи процедур AddKey...(). После завершения поиска, независимо от результата, выражение для поиска(ключ) обнуляется!

Пример:

-- Необходимо найти все счета, открытые с 12/05/2004 по 14/05/2004
-- В account.btr есть индекс #1 по date_open+user_id
declare fh varchar2(141):=rpad(' ',141);
    status pls_integer;
    counter pls_integer;
begin
    status:=btrv_utl.Open(fh,'/NW_server/pupsik/bank/account.dat');
    btrv_utl.SetKeyNum(fh,1);
    btrv_utl.AddKeyDate(fh,'20040512');
    btrv_utl.GetGe(fh);
    while btrv_utl.GetStatus=0 and btrv_utl.GetDate(fh,24)<=to_date('20040514','yyyymmdd') loop
<=to_date('20040514','yyyymmdd') loop
        dbms_output.put_line('Account='||btrv_utl.GetString(fh,4,20));
        btrv_utl.GetNext(fh);
    end loop;
    status:=btrv_utl.Close(fh);
end;
procedure GetNext(fh in out varchar2)

Функция переходит на следущую запись по текущему индексу в заданном открытом файле Btrieve.
procedure GetFirst(fh in out varchar2)

Функция переходит на первую запись по текущему индексу в заданном открытом файле Btrieve.
procedure GetPrev(fh in out varchar2)

Функция переходит на предыдущую запись по текущему индексу в заданном открытом файле Btrieve.
procedure GetLast(fh in out varchar2)

Функция переходит на последнюю запись по текущему индексу в заданном открытом файле Btrieve.
procedure GetGt(fh in out varchar2)
Функция выполняет поиск в заданном открытом файле Btrieve по условию значение ключа в индексе > выражение для поиска (ключ). Поиск ведется по индексу. Нужный индекс должен быть заранее выбран при помощи функции SetKeyNum(). Ключ(выражение для поиска) задается при помощи процедур AddKey...(). После завершения поиска, независимо от результата, выражение для поиска(ключ) обнуляется!
procedure GetLe(fh in out varchar2)

Функция выполняет поиск в заданном открытом файле Btrieve по условию значение ключа в индексе <= выражение для поиска (ключ). Поиск ведется по индексу. Нужный индекс должен быть заранее выбран при помощи функции SetKeyNum(). Ключ(выражение для поиска) задается при помощи процедур AddKey...(). После завершения поиска, независимо от результата, выражение для поиска(ключ) обнуляется!
procedure GetLt(fh in out varchar2)

Функция выполняет поиск в заданном открытом файле Btrieve по условию значение ключа в индексе < выражение для поиска (ключ). Поиск ведется по индексу. Нужный индекс должен быть заранее выбран при помощи функции SetKeyNum(). Ключ(выражение для поиска) задается при помощи процедур AddKey...(). После завершения поиска, независимо от результата, выражение для поиска(ключ) обнуляется!
function GetDouble(fh varchar2,pos pls_integer) return double pricision

Извлекает значение типа double из текущей записи открытого файла Btrieve. Необходимо указать смещение нужного поля от начала записи. Символы отсчитываются от 0, т.е. позиция первого байта в записи считается 0.
function GetShort(fh varchar2,pos pls_integer) return pls_integer

Извлекает значение типа Short из текущей записи открытого файла Btrieve. Необходимо указать смещение нужного поля от начала записи. Символы отсчитываются от 0, т.е. позиция первого байта в записи считается 0.
function GetLong(fh varchar2,pos pls_integer) return pls_integer

Извлекает значение типа long из текущей записи открытого файла Btrieve. Необходимо указать смещение нужного поля от начала записи. Символы отсчитываются от 0, т.е. позиция первого байта в записи считается 0.
function GetDate(fh varchar2,pos pls_integer) return date

Извлекает значение типа Date из текущей записи открытого файла Btrieve. Необходимо указать смещение нужного поля от начала записи. Символы отсчитываются от 0, т.е. позиция первого байта в записи считается 0.
function GetString(fh varchar2,pos pls_integer,len pls_integer) return varchar2

Извлекает значение строкового типа из текущей записи открытого файла Btrieve. Необходимо указать смещение нужного поля от начала записи. Символы отсчитываются от 0, т.е. позиция первого байта в записи считается 0, и размер извлекаемого поля. Так как значение возвращается в бинарном виде, можно использовать эту функцию для извлечения значения любого типа с последующим самостоятельным конвертированием в нужный тип из бинарной строки. Также можно извлекать сразу несколько рядом расположенных полей (и, вообще, любой кусок записи) с последующим самостоятельным разбором.
procedure AddKeyShort(fh in out varchar2,shortvalue pls_integer)

Процедура добавляет к выражению для поиска(ключу) значение типа Short. Ключ используется функциями Get...() и автоматически обнуляется после первого вызова функций GetEq,GetGt,GetLt,GetGe или GetLe.
procedure AddKeyLong(fh in out varchar2,longvalue pls_integer)

Процедура добавляет к выражению для поиска(ключу) значение типа Long. Ключ используется функциями Get...() и автоматически обнуляется после первого вызова функций GetEq,GetGt,GetLt,GetGe или GetLe.
procedure AddKeyString(fh in out varchar2,strvalue varchar2,strsize pls_integer)

Процедура добавляет к выражению для поиска(ключу) значение типа строка. Ключ используется функциями Get...() и автоматически обнуляется после первого вызова функций GetEq,GetGt,GetLt,GetGe или GetLe. Так как строка передается как бинарное выражение, то можно использовать эту функцию для добавления любого типа данных с предварительным самостоятельным ковертированием в бинарную строку.
procedure AddKeyDate(fh in out varchar2,strvalue varchar2)

Процедура добавляет к выражению для поиска(ключу) значение типа Date. Ключ используется функциями Get...() и автоматически обнуляется после первого вызова функций GetEq,GetGt,GetLt,GetGe или GetLe. Дата передается в виде строки формата ' yyyymmdd'.
procedure SetKeyNum(fh in out varchar2,keynum pls_integer)

Процедура устанавливает номер используемого индекса для операций типа Get...(). Необходимо указать уже открытый файл и номер индекса.
procedure FreeKeyForIdx

Принудительно обнуляет ключ для поиска.
procedure GetDirect(fh in out varchar2,adr varchar2,len pls_integer,value in out varchar2)

Процедура заполняет переданную переменную Value записью извлеченной по физическому адресу adr. Параметр adr должен быть 4-байтовым физическим адресом Btrieve. Параметр len задает размер извлекаемой записи. Процедура может быть использована для извлечения записей переменной длины(мемо-поля).

function GetPosition(fh in out varchar2) return pls_integer

Функция возвращает физический адрес для текущей записи в виде integer 4 байта.

procedure SetBias(bias pls_integer)

Устанавливает дополнительные режимы для операций Btrieve в процедурах Step...(),Get...(), Open,BeginTransaction,Create,CreateIndex. Дополнительную информацию для каждой операции смотрите в документации по Btrieve.

procedure SetOwnerName(ownername varchar2)

Задает owner name (пароль), который будет использовать процедура Open. Необходимо, если Ваши файлы защищены таким паролем. Подробнее смотрите в документации по Btrieve.

procedure BeginTransaction

Начинает транзакцию Btrieve.

procedure AbortTransaction

Прерывает транзакцию Btrieve.

procedure EndTransaction

Завершает транзакцию Btrieve.

procedure SetOwner(fh in out varchar2,ownername varchar2,omode pls_integer)

Устанавливает пароль и|или шифрацию данных на файл Btrieve. Для выполнения операции файл должен быть открыт.
ownername- любой пароль длиной до 8 символов включительно.
omode- режим:

0	Btrieve будет требовать owner name для любого режима доступа (без шифрации данных).
1	Допускается открытие на чтение без указания owner name (без шифрации данных).
2	Btrieve будет требовать owner name для любого режима доступа (с шифрацией данных).
3	Допускается открытие на чтение без указания owner name(с шифрацией данных).

procedure ClearOwner(fh in out varchar2)

Снимает с файла owner name. Файл должен быть открыт.

procedure AddKeyForIdx(pos pls_integer,len pls_integer,flags pls_integer,type pls_integer,nullValue pls_integer,manKeyNum pls_integer,ascNum pls_integer)

Добавляет сегмент к выражению для построения нового индекса

procedure CreateIndex(fh in out varchar2)

Добавляет новый индекс к файлу согласно выражению построенному при помощи процедуры AddKeyForIdx

procedure PutShort(fh in out varchar2,foffset pls_integer,fvalue pls_integer)

Вставляет в запись значение типа short с указанной позиции. Используется для процедур BInsert и BUpdate.

procedure PutLong(fh in out varchar2,foffset pls_integer,fvalue pls_integer)

Вставляет в запись значение типа long с указанной позиции. Используется для процедур BInsert и BUpdate.

procedure PutDouble(fh in out varchar2,foffset pls_integer,fvalue double precision)

Вставляет в запись значение типа double с указанной позиции. Используется для процедур BInsert и BUpdate.

procedure PutString(fh in out varchar2,foffset pls_integer,fvalue varchar2,fsize pls_integer)

Вставляет в запись значение строкого типа с указанной позиции. Используется для процедур BInsert и BUpdate.
Т.к., строка передается в бинарном виде, можно использовать для значений любого типа с предварительной самостоятельной конвертацией.

procedure PutDate(fh in out varchar2,foffset pls_integer,fvalue varchar2)

Вставляет в запись значение типа date с указанной позиции. Дата передается в виде строки 'yyyymmdd'. Используется для процедур BInsert и BUpdate.

procedure BCreate(filename varchar2,reclen pls_integer,pagesize pls_integer,flags pls_integer,alloc pls_integer)

Создает новый файл Btrieve с заданными параметрами. См.документацию по Btrieve.

procedure BDelete(fh in out varchar2)

Удаляет текущую запись. Текущая запись должна быть установлена процедурами Get..() или Step...().

procedure BInsert(fh in out varchar2)

Вставляет запись в файл Btrieve. Запись должна быть полностью сформирована процедурами Put...().

procedure BUpdate(fh in out varchar2)

Редактирует текущую запись. Новые значения нужных полей должны быть установлены процедурами Put...(). Текущая запись должна быть установлена процедурами Get..() или Step...().

Вернуться на домашнюю страницу