Справочник встроенных подпрограмм и функций ORACLE FORMS DEVELOPER

COPY (value_string , target_field_name ) - записывает указанное значение в поле. COPY используется, в частности, для записи значения в поле, на которое ссылаются по упакованной процедуре NAME_IN. Это свойство существует потому, что вы не можете использовать стандартный синтаксис PL/SQL для установки поля, к которому идет доступ по ссылке, равным определенному значению.

COPY_REGION - копирует выделенный регион текстового элемента или картинки с экрана в буфер.

COPY_REPORT_OBJECT_OUTPUT - копирует выходные данные из отчета в файл.

Параметры:

• report_id - значение типа VARCHAR2, возвращаемое функцией RUN_REPORT_OBJECT, однозначно идентифицирует текущий запущенный отчет как на локали, так и на сервере.
• output_file - имя выходного файла.

COUNT_QUERY - определяет число строк, которые запрос отыщет для текущего блока. Если в блоке есть изменения, которые нужно сохранять в БД, Forms подсказывает оператору об этом при обработке COUNT_QUERY.

CREATE_GROUP - создает незапросную группу с присвоенным именем. Созданная группа не имеет ни ячеек, ни столбцов. Все последующие действия по заполнению и добавлению выполняются с помощью встроенных процедур и функций: ADD_GROUP_COLUMN, ADD_GROUP_ROW и POPULATE_GROUP_WITH_QUERY.

Параметры:

• recordgroup_name - имя группы записей. Тип данных - VARCHAR2.
• Scope - определяет вид использования группы записей, то есть будет ли группа глобальна - доступна всем формам, задействованным в приложении, - либо только текущей.
  • FORM_SCOPE - означает, что группа записей может быть использована только с текущей формой. Это значение является значением по умолчанию.
  • GLOBAL_SCOPE - означает, что группа записей будет глобальной и может быть использована всеми формами вашего многомодульного приложения. Причем однажды созданная глобальная группа записей будет действовать в течение всей сессии созданной runtime'ом формы.
• array_fetch_size - определяет размер массива извлекаемых строк. По умолчанию этот параметр имеет значение 20.

CREATE_GROUP_FROM_QUERY - создает запросную группу с заданным именем. Созданная группа уже имеет столбцы, соответствующие названиям столбцам таблицы. Для добавления ячеек нужно использовать функцию POPULATE_GROUP.

Параметры:

• recordgroup_name - имя группы записей.
• Scope - определяет вид использования группы записей, то есть будет ли группа глобальна - доступна всем формам, задействованным в приложении, - либо только текущей.
  • FORM_SCOPE - означает, что группа записей может быть использована только с текущей формой. Это значение является значением по умолчанию.
  • GLOBAL_SCOPE - означает, что группа записей будет глобальной и может быть использована всеми формами вашего многомодульного приложения. Причем однажды созданная глобальная группа записей будет действовать в течение всей сессии созданной runtime 'ом формы.
• array_fetch_size - определяет размер массива извлекаемых строк. По умолчанию этот параметр имеет значение 20.

CREATE_OLEOBJ - создает OLE-объект, который даже в случае использования другой формы будет вызываться повторно, то есть не ини-циализируясь еще раз.

• Name - программный идентификатор объектного OLE-сервера. Localobject - указатель на объект OLE, статус которого выбран как настоящий или не настоящий.
• persistence_boolean - значение типа boolean. Если подсоединен, то TRUE. По умолчанию определяется как подключенный. Это опциональный параметр. По умолчанию - TRUE.

CREATE_PARAMETER_LIST - создает лист параметров с заданным именем. После создания лист параметров не содержит никаких параметров. Параметры добавляются с помощью процедуры ADD_PARAMETER.

Парметры:

• name - определяет имя листа параметров. После создания листа параметров Form Builder создаст уникальный идентификатор для типа PARAMLIST данного листа параметров. После этого вы можете вызывать лист параметров как по идентификатору, так и по имени.

CREATE_QUERIED_RECORD - когда вызывается триггер On-Fetch, создаются записи в листе ожидания блока. Лист ожидания имитирует буфер записей, состоящий из записей, которые должны будут быть извлечены из источника данных, но еще не извлечены как "активные" записи. Эта процедура в основном предназначена для случая использования тран-закционных триггеров.

CREATE_RECORD - создает новую запись в текущем блоке после текущей записи. Затем Forms перейдет на эту новую запись.

CREATE_TIMER - создает новый таймер с заданным именем.

Параметры:

• timer_name - определяет имя таймера, причем имя должно содержать не боле 30 символов. Тип данных - VARCHAR2.
• Milliseconds - определяет действия таймера в миллисекундах. Предельное значение 2147483648. Тип данных - Number.
• Iterate - определяет поведение таймера. Поведение определяется константами:
  • REPEAT - указывает, что нужно повторять действие по истечении времени. Это значение стоит по умолчанию.
  • NO_REPEAT - указывает, что действие нужно выполнить лишь однажды.

CREATE_VAR - создает неименованную переменную. Бывает двух типов для скалярных величин и массивов:

FUNCTION CREATE_VAR (persistence BOOLEAN) RETURN newvar OLEVAR;

...or...

FUNCTION CREATE_VAR (bounds OLE_SAFEARRAYBOUNDS, vtype VT_TYPE, persistence BOOLEAN) RETURN newvar OLEVAR;

Параметры:

• persistence - состояние переменной после создания. True, если существует.
• Bounds - PL/SQL-таблица, в которой определены измерения, присваиваемые создаваемому массиву.
• vtype - тип OLE variant (VT_TYPE) элементов в созданном массиве. Если массив состоит из смешанных типов, используйте тип VT_VARIANT.

CUT_REGION - удаляет выделенный регион текстового элемента или картинки, запоминая вырезанную часть в буфере.

DBMS_ERROR_CODE - возвращает номер последней ошибки базы данных.

DBMS_ERROR_TEXT - возвращает номер сообщения (типа ORA-14041) и текст ошибки БД.

DEBUG_MODE - переводит форму в режим отладки.

DEFAULT_VALUE - копирует указанное значение в указанную переменную, если текущее значение переменной NULL, иначе DEFAULT_VALUE не делает ничего. (Поэтому для полей эта упакованная процедура работает идентично упакованной процедуре COPY для поля NULL.) Если переменная является неопределенной глобальной переменной, Forms создает эту переменную.

Параметры:

• value_string - значение для копирования в переменную. Тип данных - VARCHAR2.
• variable_name - имя переменной, в которую будем копировать значение. Тип данных - VARCHAR2.
  Замечание: упакованная процедура DEFAULT_VALUE не выполняет функции, аналогичные характеристике поля Default Value.

DELETE_GROUP - удаляет выбранную группу записей.

Параметры:

• recordgroup_id - уникальный идентификатор, который Forms Builder связывает с группой записи при создании. Функция поиска идентификатора - FIND_RECORD_GROUP. Тип данных идентификатора - RECORDGROUP группы записей.
• recordgroup_name - имя группы записей. Тип данных - VARCHAR2.

DELETE_GROUP_ROW - удаляет записи в группе.

Параметры:

• recordgroup_id - уникальный идентификатор, который Forms Builder связывает с группой записи при создании. Функция поиска идентификатора - FIND_RECORD_GROUP. Тип данных идентификатора - RECORDGROUP группы записей. Или имя группы записей, тогда тип данных VARCHAR2.
• row_number - определяет номер удаляемой ячейки, соответствующий номеру ячейки в группе. Тип данных - NUMBER. ALL_ROWS - константа, которую можно использовать для удаления сразу всех записей.

DELETE_LIST_ELEMENT - удаляет элемент из элемента списка.

Парметры:

• list_id - уникальный идентификатор, который Forms Builder связывает с элементом списка при создании. Функция поиска идентификатора - FIND_ITEM. Тип данных идентификатора - ITEM.
• list_name - имя элемента списка. Тип данных - VARCHAR2.
• list_index - специфицирует значение индекса элемента списка, то есть номер, под которым будет добавлен элемент в список элементов. Начинается с 1.

DELETE_PARAMETER - удаляет параметр и присвоенный ему ключ из списка параметров.

Параметры:

• list or name - Specifies the parameter list, either by list ID or name. The actual parameter can be either a parameter list ID of type PARAMLIST, or the VARCHAR2 name of the parameter list.
• Key - имя параметра. Тип данных ключа - VARCHAR2.

DELETE_RECORD - удаляет текущую запись из блока. Если запись соответствует строке в БД, Forms блокирует запись перед удалением ее и помечает ее как удаленную. Если в блоке открыт запрос, Forms вызывает запись для повторного заполнения блока при необходимости.

DELETE_TIMER - удаляет таймер.

Параметры:

• timer_id - уникальный идентификатор, который Forms Builder связывает с таймером при его создании.
• timer_name - имя элемента, которое вы присвоили элементу на этапе проектирования. Тип данных - VARCHAR2.

DELETE_TREE_NODE - удаляет элемент данных (узел) из дерева.

Параметры:

• Iitem_name - определяет имя элемента, в данном случае в качестве имени нужно указать block_name.tree_name типа VARCHAR2.
• Item_id - уникальный идентификатор, который Forms Builder связывает с элементом списка при создании. Используйте также FIND_ITEM для поиска данного идентификатора.
• Node - специфицирует элемент дерева.

DESTROY_PARAMETER_LIST - удаляет динамически созданный лист параметров, а также параметры, который он содержал.

Параметры:

name - определяет имя листа параметров. После создания листа параметров Form Builder создаст уникальный идентификатор для типа PARAMLIST данного листа параметров. После этого вы можете вызывать лист параметров как по идентификатору, так и по имени.

DESTROY_VARIANT - удаляет OLE-переменную, созданную функцией CREATE_VAR.

Параметры:

• variant - OLE-переменная, которая должна быть удалена.

DISPLAY_ERROR - выводит экран Display Error, если существует зарегистрированная ошибка. Когда оператор нажимает любую функциональную клавишу, Forms перерисовывает форму.

DISPLAY_ITEM - используется только для совместимости с предыдущими версиями. В новых приложениях принято использовать SET_ITEM_INSTANCE_PROPERTY. DISPLAY_ITEM - отображает элемент с заданным визуальным атрибутом.

Параметры:

• item_id or item_name - специфицирует в качестве параметра либо имя элемента, либо его идентификатор.
• attribute - название визуального атрибута, который будет назначен указанному элементу.

DOWN - передает управление на представление текущего поля в записи со следующим более старшим последовательным номером. Если необходимо, Forms вызывает на экран эту запись, которой передается управление. Если Forms должен создать запись, которой передается управление, DOWN перемещает курсор на первое вводимое поле в этой новой записи.

DUPLICATE_ITEM - назначает текущему полю то же значение, что имеет это поле в предыдущей записи.

DUPLICATE_RECORD - копирует значение каждого поля в записи с предыдущим меньшим номером в соответствующие поля текущей записи. Текущая запись уже не должна соответствовать никакой строке в БД, иначе возникает ошибка.