CurrentRecord (RecordsetCursor function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<var>CurrentRecord</var> cancels the request if it cannot create a <var>Record</var> object because there is no | <var>CurrentRecord</var> cancels the request if it cannot create a <var>Record</var> object because there is no | ||
current record. | current record. | ||
==Syntax== | ==Syntax== | ||
{{Template:RecordsetCursor:CurrentRecord syntax}} | {{Template:RecordsetCursor:CurrentRecord syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
| Line 13: | Line 15: | ||
</td></tr> | </td></tr> | ||
<tr><th>lockStrength</th> | <tr><th>lockStrength</th> | ||
<td>A <var>Lockstrength</var> enumeration value: <var>None</var>, <var>Share</var>, or <var>Exclusive</var>. These correspond to standard <var class="product">Model 204</var> record-locking levels, as described below. The default lock strength is <var>Share</var>, matching the locking behavior of a <var class="product">User Language</var> <var>For Record Number</var> statement. <dl> <dt>None <dd>Record is not locked. <br> No locks are held on the object, so there is no conflict with others holding <var>Share</var> or <var>Exclusive</var> locks (readers and updaters may proceed). <dt>Share <dd>Record is share locked. <br> This level allows other users to hold a <var>Share</var> lock, but not an <var>Exclusive</var> lock (allows readers but not updaters to proceed). <dt>Exclusive <dd>Record is exclusively locked. <br> This level prohibits others from holding either an <var>Exclusive</var> lock or a <var>Share</var> lock. It is generally used for update. </dl> | <td>A <var>Lockstrength</var> [[Enumerations|enumeration]] value: <var>None</var>, <var>Share</var>, or <var>Exclusive</var>. These correspond to standard <var class="product">Model 204</var> record-locking levels, as described below. The default lock strength is <var>Share</var>, matching the locking behavior of a <var class="product">User Language</var> <var>For Record Number</var> statement. <dl> <dt>None <dd>Record is not locked. <br> No locks are held on the object, so there is no conflict with others holding <var>Share</var> or <var>Exclusive</var> locks (readers and updaters may proceed). <dt>Share <dd>Record is share locked. <br> This level allows other users to hold a <var>Share</var> lock, but not an <var>Exclusive</var> lock (allows readers but not updaters to proceed). <dt>Exclusive <dd>Record is exclusively locked. <br> This level prohibits others from holding either an <var>Exclusive</var> lock or a <var>Share</var> lock. It is generally used for update. </dl> | ||
</td></tr> | </td></tr> | ||
<tr><th><var>LoopLockStrength</var></th> | <tr><th><var>LoopLockStrength</var></th> | ||
| Line 19: | Line 21: | ||
</td></tr></table> | </td></tr></table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li><var>CurrentRecord</var> is valid only if cursor state is <var>HasRecord</var>. | <li><var>CurrentRecord</var> is valid only if cursor state is <var>HasRecord</var>. | ||
<li>The default lock strength of the new record object is <var>Share</var>. | <li>The default lock strength of the new record object is <var>Share</var>. | ||
</ul> | </ul> | ||
==See also== | ==See also== | ||
{{Template:RecordsetCursor:CurrentRecord footer}} | {{Template:RecordsetCursor:CurrentRecord footer}} | ||
Latest revision as of 23:37, 22 February 2012
Create Record object from current record in the set (RecordsetCursor class)
CurrentRecord cancels the request if it cannot create a Record object because there is no current record.
Syntax
%record = recordsetCursor:CurrentRecord[( [lockStrength], - [LoopLockStrength= lockStrength])]
Syntax terms
| %record | A Record object variable for the assignment of the current record in recordsetCursor's record set. record must have the same file or group context as recordsetCursor. |
|---|---|
| recordsetCursor | A RecordsetCursor object. |
| lockStrength | A Lockstrength enumeration value: None, Share, or Exclusive. These correspond to standard Model 204 record-locking levels, as described below. The default lock strength is Share, matching the locking behavior of a User Language For Record Number statement.
|
| LoopLockStrength | The lock strength to be used for For Record loops on the Record object. This is an optional, name required, parameter, and it defaults to None. Its possible values are described above. |
Usage notes
- CurrentRecord is valid only if cursor state is HasRecord.
- The default lock strength of the new record object is Share.