LockStrength (RecordsetCursor function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:RecordsetCursor:LockStrength subtitle}}
{{Template:RecordsetCursor:LockStrength subtitle}}
 
To indicate the lock strength of the <var>RecordsetCursor</var> object, this method returns a <var>LockStrength</var> enumeration.
This read-only property returns a <var>LockStrength</var> enumeration
that indicates the lock strength of the <var>RecordsetCursor</var> object.


Since a <var>RecordsetCursor</var> is simply a window, of sorts, into a
Since a <var>RecordsetCursor</var> is simply a window, of sorts, into a
Line 10: Line 8:
Since <var>SortedRecordsets</var> are not locked, a <var>RecordsetCursor</var> on a
Since <var>SortedRecordsets</var> are not locked, a <var>RecordsetCursor</var> on a
<var>SortedRecordset</var> object has a <var>LockStrength</var> of <var>None</var>.
<var>SortedRecordset</var> object has a <var>LockStrength</var> of <var>None</var>.
==Syntax==
==Syntax==
{{Template:RecordsetCursor:LockStrength syntax}}
{{Template:RecordsetCursor:LockStrength syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%ls</th>
<tr><th>%lockStrength</th>
<td>A declared enumeration object of type <var>LockStrength</var> to contain the returned value of ''%cursor'''s locking. The enumeration values (shared properties) that may be returned (<var>None</var>, <var>Share</var>, or <var>Exclusive</var>) correspond to standard <var class="product">Model 204</var> record-locking levels, as described in [[New (Record constructor)|"New (Record constructor)"]].
<td>A <var>LockStrength</var> [[Enumerations|enumeration]] variable to contain the returned value of <var class="term">recordsetCursor</var>'s locking. The enumeration values (shared properties) that may be returned (<var>None</var>, <var>Share</var>, or <var>Exclusive</var>) correspond to standard <var class="product">Model 204</var> record-locking levels, as described in [[New (Record constructor)|"New (Record constructor)"]].
</td></tr>
</td></tr>
<tr><th>%rscursor</th>
<tr><th>recordsetCursor</th>
<td>An instantiated <var>RecordsetCursor</var> object variable.
<td>A <var>RecordsetCursor</var> object.
</td></tr></table>
</td></tr></table>
==Usage notes==
 
<ul>
<li>This property is only available in <var class="product">Sirius Mods</var> 7.0 and later.
<li>For more information about enumerations, see [[Enumerations]].
</ul>
==See also==
==See also==
{{Template:RecordsetCursor:LockStrength footer}}
{{Template:RecordsetCursor:LockStrength footer}}

Latest revision as of 20:40, 12 November 2012

Return lock strength of RecordsetCursor object (RecordsetCursor class)

To indicate the lock strength of the RecordsetCursor object, this method returns a LockStrength enumeration.

Since a RecordsetCursor is simply a window, of sorts, into a Recordset or SortedRecordset object, the LockStrength of a RecordsetCursor object is actually the LockStrength of the underlying Recordset or SortedRecordset object. Since SortedRecordsets are not locked, a RecordsetCursor on a SortedRecordset object has a LockStrength of None.

Syntax

%lockStrength = recordsetCursor:LockStrength

Syntax terms

%lockStrength A LockStrength enumeration variable to contain the returned value of recordsetCursor's locking. The enumeration values (shared properties) that may be returned (None, Share, or Exclusive) correspond to standard Model 204 record-locking levels, as described in "New (Record constructor)".
recordsetCursor A RecordsetCursor object.

See also