cursorgetprop( ) 函数

返回 Visual FoxPro 表或临时表的当前属性设置。

语法

CURSORGETPROP(cProperty [, nWorkArea | cTableAlias])

返回值类型

字符型, 数值型或逻辑型

参数

cProperty

指定要返回的属性设置。
下表列出了可以返回的属性设置、返回值的数据类型以及返回值说明。

cProperty  类型 说明 
BatchUpdateCount* N 送到缓冲表后端的更新语句的数目。1 是默认值。调整该值可大大提高更新的性能。可读写。 
Buffering N 1 - (默认值)行缓冲和表缓冲关闭。
            2 打开保守式行缓冲。
            3 打开开放式行缓冲。
            4 打开保守式表缓冲。
            5 打开开放式表缓冲。可读写。 
CompareMemo L 若用于检测更新冲突的 WHERE 子句中包含备注字段或通用字段，返回 .T. (默认)；否则，返回 .F. 。本属性只用于视图。可读写。 
ConnectHandle N 连接句柄。
只读。 
ConnectName C 在创建临时表时使用的命名连接。
只读。  
Database C 包含表或视图的数据库名称。如表是自由表，包含空字符串。
只读。 
FetchAsNeeded L 若只有在需要时才将数据调入，返回 .T.；否则，返回 .F.(默认)。 
可读写。
 
FetchMemo* L 如果视图结果中含有备注字段，则为“真”(.T.)，否则为“假”(.F.)(默认值)。
可读写。 
FetchSize* N 从远程表结果集合中逐步提取的行数。默认是 100 行。设置 FetchSize 为 -1 将检索整个结果集(但受 MaxRecords 设置限制)。
可读写。 
KeyFieldList C 逗号分隔的临时表的主字段列表。
可读写。 
MaxRecords* N 当返回结果集时所提取的最大行数。默认值是 1(返回所有行)。0 值指定运行视图，但不提取结果。
可读写。
 
Prepared L 如果 SQL 语句已准备好，可以执行 REQUERY()，返回 .T. ；否则，返回 .F. (默认)。REQUERY()用于从一个 SQL 视图中重新检索数据。有关 SQL 语句的准备，请参阅SQLPREPARE( )。本属性只用于视图。可读写。 
SendUpdates L 如果 SQL 更新查询被执行以更新远程表，则为“真”(.T.)；否则为“假”(.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-指定通过删除旧数据，插入新数据来进行更新。可读写。 
UseMemoSize* N 使得结果返回到备注字段的列的最小宽度(按字节)。例如，如果一个列的结果的宽度比UseMemoSize 的值大，列结果存储在备注字段中。UseMemoSize 可以从 1 到 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 属性指定的主关键字段和时间戳。可读写。  

* 此属性的返回值只对远程视图才是重要的，如果您对本地视图取得此属性，CURSORGETPROP 函数返回默认值。

下表中包含可以返回设置的属性、返回值的数据类型及返回值的说明的列表。

cProperty 类型 说明 
BatchUpdateCount* N 送到缓冲表后端的更新语句的数目。1 是默认值。调整该值可大大提高更新的性能。可读写。 
Buffering N 1-(默认值)行缓冲和表缓冲关闭。2-打开保守式行缓冲。3-打开开放式行缓冲。4-打开保守式表缓冲。5-打开开放式表缓冲。可读写。 
CompareMemo L 若用于检测更新冲突的 WHERE 子句中包含备注字段或通用字段，返回 .T. (默认)；否则，返回 .F. 。本属性只用于视图。可读写。 
ConnectHandle N 连接句柄。只有在数据源中包含远程表时此属性才有效。只读。 
ConnectName C 在创建临时表时使用的命名连接。只有在数据源中包含远程表时此属性才有效。只读。  
Database C 包含表或视图的数据库名称。如表是自由表，包含空字符串。只读。 
FetchAsNeeded L 若只有在需要时才将数据调入，返回 .T.；否则，返回 .F.(默认)。可读写。 
FetchMemo* L 如果视图结果中含有备注字段，则为“真”(.T.)；否则为“假”(.F.)(默认值)。可读写。 
FetchSize* N 从远程表结果集合中逐步提取的行数。默认是100 行。设置 FetchSize 为 -1 将检索整个结果集(但受 MaxRecords 设置限制)。可读写。 
KeyFieldList C 逗号分隔的临时表的主字段列表。可读写。 
MaxRecords* N 当返回结果集时所提取的最大行数。默认值是-1(返回所有行)。0 值指定运行视图，但不提取结果。可读写。 
Prepared L 如果 SQL 语句已准备好，可以执行 REQUERY()，返回 .T. ；否则，返回 .F. (默认)。REQUERY()用于从一个 SQL 视图中重新检索数据。有关 SQL 语句的准备，请参阅SQLPREPARE( )。本属性只用于视图。可读写。 
SendUpdates L 如果 SQL 更新查询被执行以更新远程表，则为“真”(.T.)；否则为“假”(.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-指定通过删除旧数据，插入新数据来进行更新。可读写。 
UseMemoSize* N 使得结果返回到备注字段的列的最小宽度(按字节)。例如，如果一个列的结果的宽度比UseMemoSize 的值大，列结果存储在备注字段中。UseMemoSize 可以从 1 到 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 属性指定的主关键字段和时间戳。可读写。  

* 此属性的返回值只对远程视图才是重要的，如果您对本地视图取得此属性，CURSORGETPROP 函数返回默认值。 
nWorkArea

从返回的属性设置可以指定表的工作区域。如果指定工作区域为0，CURSORGETPROP()函数返回环境设置。

cTableAlias

从返回的属性设置可以指定工作表 的别名。

说明

可用 CURSORSETPROP( )设置 Visual FoxPro 表或临时表的具体属性。有关每个属性及它们的设置，请参阅 CURSORSETPROP()。

如果发出不带可选 cTableAlias 或 nWorkArea 参数的 CURSORGETPROP()命令，则在当前选定工作区中打开的表或临时表的当前属性设置被返回。