LockStrength (RecordsetCursor function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (Created page with "<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span> LockStrength property <p> <var>LockStrength</var> is a mem...")
 
m (Created page with "<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span> LockStrength property <p> <var>LockStrength</var> is a mem...")
Line 1: Line 1:
<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
{{Template:RecordsetCursor:LockStrength subtitle}}
[[Category:RecordsetCursor methods|LockStrength property]]
<p>
<var>LockStrength</var> is a member of the <var>[[RecordsetCursor class|RecordsetCursor]]</var> class.
</p>


This read-only property returns a <var>LockStrength</var> enumeration
This read-only property returns a <var>LockStrength</var> enumeration
Line 15: Line 11:
<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==
<p class="syntax">%ls = %rscursor:LockStrength
{{Template:RecordsetCursor:LockStrength syntax}}
</p>
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
Line 25: Line 20:
<td>An instantiated <var>RecordsetCursor</var> object variable.
<td>An instantiated <var>RecordsetCursor</var> object variable.
</td></tr></table>
</td></tr></table>
==Usage Notes==
==Usage notes==
<ul>
<ul>
<li>This property is only available in <var class="product">Sirius Mods</var> 7.0 and later.
<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]].
<li>For more information about enumerations, see [[Enumerations]].
</ul>
</ul>
==See also==
{{Template:RecordsetCursor:LockStrength footer}}

Revision as of 22:48, 26 April 2011

Return lock strength of RecordsetCursor object (RecordsetCursor class)


This read-only property returns a LockStrength enumeration that indicates the lock strength of the RecordsetCursor object.

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

%ls A declared enumeration object of type LockStrength to contain the returned value of %cursor'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)".
%rscursor An instantiated RecordsetCursor object variable.

Usage notes

  • This property is only available in Sirius Mods 7.0 and later.
  • For more information about enumerations, see Enumerations.

See also