Difference between revisions of "CURSORGETPROP()"

From Recital Documentation Wiki
Jump to: navigation, search
 
(2 intermediate revisions by one user not shown)
Line 1: Line 1:
 
==Purpose==
 
==Purpose==
Function to  
+
Function to return the current property settings for a table or cursor
  
  
 
==Syntax==
 
==Syntax==
CURSORGETPROP()
+
CURSORGETPROP(<expC> [, <workarea | alias>])
  
  
Line 12: Line 12:
  
 
==Description==
 
==Description==
 +
The CURSORGETPROP() function can be used to return the current property settings for a table or cursor.
  
 +
If the optional <workarea | alias> is specified, then the function will operate in the required location.
 +
 +
====<expC>====
 +
{| class="wikitable"
 +
!Value||Description
 +
|-
 +
|Buffering||Current Buffering setting
 +
|-
 +
|}
 +
 +
 +
====Return Value====
 +
{| class="wikitable"
 +
!Value||Description
 +
|-
 +
|1||Row and table buffering are off (default)
 +
|-
 +
|2||Pessimistic row buffering is on
 +
|-
 +
|3||Optimistic row buffering is on
 +
|-
 +
|4||Pessimistic table buffering is on
 +
|-
 +
|5||Optimistic table buffering is on
 +
|-
 +
|}
  
  

Latest revision as of 12:14, 22 August 2011

Purpose

Function to return the current property settings for a table or cursor


Syntax

CURSORGETPROP(<expC> [, <workarea | alias>])


See Also

CURSORSETPROP(), CURVAL(), GETFLDSTATE(), OLDVAL(), TABLEREVERT(), TABLEUPDATE(), SETFLDSTATE()


Description

The CURSORGETPROP() function can be used to return the current property settings for a table or cursor.

If the optional <workarea | alias> is specified, then the function will operate in the required location.

<expC>

Value Description
Buffering Current Buffering setting


Return Value

Value Description
1 Row and table buffering are off (default)
2 Pessimistic row buffering is on
3 Optimistic row buffering is on
4 Pessimistic table buffering is on
5 Optimistic table buffering is on


Example

close databases
clear
set exclusive off
open database southwind
use customers
// Set to known value before start
replace customerid with "ALFKI"
 
cursorsetprop("Buffering", 5, "customers")
messagebox("Buffering set to " +etos(cursorgetprop("Buffering")))
 
? "Original customerid value: " + customerid
? "Curval(): " + curval("customerid")
? "Oldval(): " + oldval("customerid")
? "Fieldstate at start: " + getfldstate("customerid")
 
replace customerid WITH "RECIT"
 
// Alter in another session
! recital -c "update southwind\!customers set customerid = 'MULTI' where recno() = 1"
? "Someone else just updated the record!"
? "New customerid value: " +  customerid 
? "Curval(): " + curval("customerid")
? "Oldval(): " + oldval("customerid")
? "Fieldstate after replace: " + getfldstate("customerid")
tablerevert(.T.)
 
? "Reverted customerid value: " +  customerid
? "Curval(): " + curval("customerid")
? "Oldval(): " + oldval("customerid")
? "Fieldstate after revert: " + getfldstate("customerid")
 
replace customerid WITH "RECIT"
? "New customerid value: " +  customerid 
tableupdate(.T.)
? "Updated customerid value: " +  customerid
? "Curval(): " + curval("customerid")
? "Oldval(): " + oldval("customerid")
? "Fieldstate after replace and update: " + getfldstate("customerid")
?


Products

Recital, Recital Server