LoopLockStrength (Recordset property): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Usage notes) |
||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Recordset:LoopLockStrength subtitle}} | {{Template:Recordset:LoopLockStrength subtitle}} | ||
The <var>LoopLockStrength</var> property uses a <var>LockStrength</var> enumeration to indicate the minimum lock strength for records processed | |||
in <var>For</var> loops on the <var>Recordset</var> object. | in <var>For</var> loops on the <var>Recordset</var> object. | ||
For more information see [[Recordset class#LoopLockStrength for Recordsets|"LoopLockStrength for Recordsets"]]. | For more information see [[Recordset class#LoopLockStrength for Recordsets|"LoopLockStrength for Recordsets"]]. | ||
==Syntax== | ==Syntax== | ||
{{Template:Recordset:LoopLockStrength syntax}} | {{Template:Recordset:LoopLockStrength syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%currentLockStrength</th> | ||
<td> | <td>The <var>[[LockStrength enumeration|LockStrength]]</var> enumeration value of <var class="term">recordset</var>'s <var>LoopLockStrength</var> property. </td></tr> | ||
<tr><th>recordset</th> | |||
<td>A <var>Recordset</var> object. | |||
</td></tr> | </td></tr> | ||
<tr><th> | <tr><th>newLockStrength</th> | ||
<td> | <td>The <var>LockStrength</var> enumeration value to assign to <var class="term">recordset</var>'s <var>LoopLockStrength</var> property. | ||
</td></tr></table> | |||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>The <var>LoopLockStrength</var> property is new as of <var class="product">Sirius Mods</var> version 7.0. | <li>The <var>LoopLockStrength</var> property is new as of <var class="product">Sirius Mods</var> version 7.0. | ||
<li>If the returned locking value is assigned to an enumeration variable, | <li>If the returned locking value is assigned to an enumeration variable, | ||
use the <var>[[ToString]]</var> enumeration method | use the <var>[[Enumerations#ToString_property|ToString]]</var> enumeration method to print the value string. | ||
to print the value string. | |||
<li>For more information about enumerations, see [[Enumerations|"Enumerations"]]. | <li>For more information about enumerations, see [[Enumerations|"Enumerations"]]. | ||
</ul> | </ul> | ||
==See also== | ==See also== | ||
<ul> | |||
<li><var>[[LockStrength (Recordset function)|LockStrength]]</var> | |||
</ul> | |||
{{Template:Recordset:LoopLockStrength footer}} | {{Template:Recordset:LoopLockStrength footer}} | ||
Latest revision as of 23:10, 22 February 2012
Set or return minimum lock strength for Recordset records that are in For loops (Recordset class)
The LoopLockStrength property uses a LockStrength enumeration to indicate the minimum lock strength for records processed in For loops on the Recordset object. For more information see "LoopLockStrength for Recordsets".
Syntax
%currentLockStrength = recordset:LoopLockStrength recordset:LoopLockStrength = newLockStrength
Syntax terms
| %currentLockStrength | The LockStrength enumeration value of recordset's LoopLockStrength property. |
|---|---|
| recordset | A Recordset object. |
| newLockStrength | The LockStrength enumeration value to assign to recordset's LoopLockStrength property. |
Usage notes
- The LoopLockStrength property is new as of Sirius Mods version 7.0.
- If the returned locking value is assigned to an enumeration variable, use the ToString enumeration method to print the value string.
- For more information about enumerations, see "Enumerations".