www.ПЕРВЫЕ ШАГИ.ru :: Функция CURSORGETPROP()

Возвращает текущие установки свойств таблицы или курсора Visual FoxPro.

Синтаксис:

CURSORGETPROP(cProperty [, nWorkArea | cTableAlias])

Параметры:
cProperty
Задает установку свойства, которую следует получить.
В следующей таблице перечислены свойства, установки которых могут быть возвращены, типы данных возвращаемых значений и описания возвращаемых значений.

cProperty Тип Описание
BatchUpdateCount N Число операторов обновления, переданных в выходной буфер для буферизованных таблиц. По умолчанию принимается 1. Правильно подобрав это значение, можно существенно повысить производительность процедуры обновления. Чтение/запись.
Buffering N 1 - (по умолчанию) Буферизация строк и таблиц отключена. 2 - Включена жесткая буферизация строк. 3 - Включена мягкая буферизация строк. 4 - Включена жесткая буферизация таблицы. 5 - Включена мягкая буферизация таблицы. Чтение/запись.
ConnectHandle N Дескриптор соединения. Только чтение.
ConnectName C Именованное соединение, использованное при создании курсора. Только чтение.
Database C Имя базы данных, в которой содержится таблица или представление. Если таблица является свободной, указывается пустая строка. Только чтение.
FetchMemo L Содержит значение "истина" (.T.), если выбираются memo-поля с результатами представления; в противном случае содержит значение "ложь" (.F.) (по умолчанию). Чтение/запись.
FetchSize N Число строк, выбранных поочередно из результирующего множества удаленной таблицы. По умолчанию берется 100 строк. Установка FetchSize в -1 выбирает полное результирующее множество (ограниченный установкой MaxRecords). Чтение/запись.
KeyFieldList C Список первичных полей для курсора через запятую. Чтение/запись.
MaxRecords N Максимальное число выбранных строк в случае, когда выбираются результирующие множества. По умолчанию принимается - 1 (возвращаются все строки). Значение 0 указывает, что представление выполнено, но никакие результаты не выбраны. Чтение/запись.
SendUpdates L Содержит значение "истина" (.T.), если выдан запрос SQL на обновление удаленных таблиц; в противном случае содержит значение "ложь" (.F.). Чтение/запись.
SourceName C Содержит длинное имя для представления SQL или таблицы базы данных или путь файла и имя таблицы для свободной таблицы. Только чтение.
SourceType N 1 - Указывает, что источником данных служит локальное представление SQL.2 - Указывает, что источником данных служит удаленное представление SQL.3 - Указывает, что источником данных служит таблица. Только чтение.
SQL C Выполняется оператор SQL в момент создания курсора. Только чтение.
Tables C Список имен удаленных таблиц через запятую. Чтение/запись.
UpdatableFieldList C Список (через запятую) имен удаленных полей и имен локальных полей, назначенных курсору. Данную опцию следует использовать при задании допустимых имен Visual FoxPro для полей в курсоре, содержащем недопустимые имена полей Visual FoxPro. Чтение/запись.
UpdateNameList C Список полей в представлении через запятую. В этот список могут быть включены поля из локальных и удаленных таблиц. Чтение/запись.
UpdateType N 1 - Указывает, что старые данные обновляются новыми. 2 - Указывает, что обновление состоит в удалении старых данных и вставке новых. По умолчанию принимается значение 1.
UseMemoSize N Минимальный размер результирующих столбцов (в байтах), при котором они возвращаются в memo-полях. Например, если ширина столбца-результата больше значения UseMemoSize, этот столбец сохраняется в memo-поле. Величина UseMemoSize может варьироваться в диапазоне от 1 дo 255, по умолчанию принимается 255. Чтение/запись.
WhereType N Предложение WHERE для обновления удаленных таблиц. WhereType может принимать следующие значения: 1 или DB_KEY (из FOXPRO.H). Предложение WHERE, используемое для обновления удаленных таблиц, состоит только из первичных полей, заданных свойством KeyFieldList. 2 или DB_KEYANDUPDATABLE (из FOXPRO.H). Предложение WHERE, используемое для обновления удаленных таблиц, состоит из первичных полей, заданных свойством KeyFieldList, и любых полей, которые можно обновить. 3 или DB_KEYANDMODIFIED (из FOXPRO.H) (по умолчанию). Предложение WHERE, используемое для обновления удаленных таблиц, состоит из первичных полей, заданных свойством KeyFieldList, и любых других обновляемых полей.4 или DB_KEYANDTIMESTAMP (из FOXPRO.H). Предложение WHERE, используемое для обновления удаленных таблиц, состоит из первичных полей, заданных свойством KeyFieldList, и сравнений полей Timestamp. Подробнее о свойстве WhereType см. главу 8 "Создание многотабличных представлений" Руководства разработчика.

cProperty	Тип	Описание
BatchUpdateCount	N	Число операторов обновления, переданных в выходной буфер для буферизованных таблиц. По умолчанию принимается 1. Правильно подобрав это значение, можно существенно повысить производительность процедуры обновления. Чтение/запись.
Buffering	N	1 - (по умолчанию) Буферизация строк и таблиц отключена. 2 - Включена жесткая буферизация строк. 3 - Включена мягкая буферизация строк. 4 - Включена жесткая буферизация таблицы. 5 - Включена мягкая буферизация таблицы. Чтение/запись.
ConnectHandle	N	Дескриптор соединения. Только чтение.
ConnectName	C	Именованное соединение, использованное при создании курсора. Только чтение.
Database	C	Имя базы данных, в которой содержится таблица или представление. Если таблица является свободной, указывается пустая строка. Только чтение.
FetchMemo	L	Содержит значение "истина" (.T.), если выбираются memo-поля с результатами представления; в противном случае содержит значение "ложь" (.F.) (по умолчанию). Чтение/запись.
FetchSize	N	Число строк, выбранных поочередно из результирующего множества удаленной таблицы. По умолчанию берется 100 строк. Установка FetchSize в -1 выбирает полное результирующее множество (ограниченный установкой MaxRecords). Чтение/запись.
KeyFieldList	C	Список первичных полей для курсора через запятую. Чтение/запись.
MaxRecords	N	Максимальное число выбранных строк в случае, когда выбираются результирующие множества. По умолчанию принимается - 1 (возвращаются все строки). Значение 0 указывает, что представление выполнено, но никакие результаты не выбраны. Чтение/запись.
SendUpdates	L	Содержит значение "истина" (.T.), если выдан запрос SQL на обновление удаленных таблиц; в противном случае содержит значение "ложь" (.F.). Чтение/запись.
SourceName	C	Содержит длинное имя для представления SQL или таблицы базы данных или путь файла и имя таблицы для свободной таблицы. Только чтение.
SourceType	N	1 - Указывает, что источником данных служит локальное представление SQL.2 - Указывает, что источником данных служит удаленное представление SQL.3 - Указывает, что источником данных служит таблица. Только чтение.
SQL	C	Выполняется оператор SQL в момент создания курсора. Только чтение.
Tables	C	Список имен удаленных таблиц через запятую. Чтение/запись.
UpdatableFieldList	C	Список (через запятую) имен удаленных полей и имен локальных полей, назначенных курсору. Данную опцию следует использовать при задании допустимых имен Visual FoxPro для полей в курсоре, содержащем недопустимые имена полей Visual FoxPro. Чтение/запись.
UpdateNameList	C	Список полей в представлении через запятую. В этот список могут быть включены поля из локальных и удаленных таблиц. Чтение/запись.
UpdateType	N	1 - Указывает, что старые данные обновляются новыми. 2 - Указывает, что обновление состоит в удалении старых данных и вставке новых. По умолчанию принимается значение 1.
UseMemoSize	N	Минимальный размер результирующих столбцов (в байтах), при котором они возвращаются в memo-полях. Например, если ширина столбца-результата больше значения UseMemoSize, этот столбец сохраняется в memo-поле. Величина UseMemoSize может варьироваться в диапазоне от 1 дo 255, по умолчанию принимается 255. Чтение/запись.
WhereType	N	Предложение WHERE для обновления удаленных таблиц. WhereType может принимать следующие значения: 1 или DB_KEY (из FOXPRO.H). Предложение WHERE, используемое для обновления удаленных таблиц, состоит только из первичных полей, заданных свойством KeyFieldList. 2 или DB_KEYANDUPDATABLE (из FOXPRO.H). Предложение WHERE, используемое для обновления удаленных таблиц, состоит из первичных полей, заданных свойством KeyFieldList, и любых полей, которые можно обновить. 3 или DB_KEYANDMODIFIED (из FOXPRO.H) (по умолчанию). Предложение WHERE, используемое для обновления удаленных таблиц, состоит из первичных полей, заданных свойством KeyFieldList, и любых других обновляемых полей.4 или DB_KEYANDTIMESTAMP (из FOXPRO.H). Предложение WHERE, используемое для обновления удаленных таблиц, состоит из первичных полей, заданных свойством KeyFieldList, и сравнений полей Timestamp. Подробнее о свойстве WhereType см. главу 8 "Создание многотабличных представлений" Руководства разработчика.

nWorkArea
Задает рабочую область таблицы или курсора, из которого возвращается установка свойства. Если вы задаете значение 0 для nWorkArea, то функция CURSORGETPROP( ) возвращает установки среды.
cTableAlias
Задает псевдоним таблицы или курсора, из которого возвращается установка свойства.

Результат
Символьный, числовой или логический

Комментарии
Пользуйтесь функцией CURSORSETPROP( ) для установки значения конкретного свойства таблицы или курсора Visual FoxPro. Подробнее о каждом из свойств и их установках см. тему CURSORSETPROP( ).
Если функция CURSORGETPROP( ) выдается без необязательных аргументов cTableAlias или nWorkArea, возвращаются текущие установки свойств для таблицы или курсора, открытых в выбранной в данный момент рабочей области.

Пример

* В данном примере открывается таблица customer в базе данных testdata.
* Далее используется функция CURSORGETPROP( ), чтобы показать моду
* буферизации для таблицы и имя базы данных, в которой хранится
* таблица.

CLOSE DATABASES
SET PATH TO (HOME( ) + 'samples\data\')  	&& Sets path to database
OPEN DATABASE testdata  && Open testdata database
USE customer	  && Open customer table

? CURSORGETPROP('Buffering')  && Displays buffering mode
? CURSORGETPROP('Database')  && Displays database name