LockStrength (Record function): Difference between revisions
Jump to navigation
Jump to search
m (Created page with "<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span> LockStrength function <p> <var>LockStrength</var> is a member of th...") |
mNo edit summary |
||
| (4 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Record:LockStrength subtitle}} | {{Template:Record:LockStrength subtitle}} | ||
This method returns a <var>LockStrength</var> enumeration | |||
to indicate the locking of the <var>Record</var> object. | |||
==Syntax== | ==Syntax== | ||
{{Template:Record:LockStrength syntax}} | {{Template:Record:LockStrength syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%lockStrength</th> | ||
<td> | <td>An <var>[[Enumerations|Enumeration]]</var> object of type <var>LockStrength</var> to contain the returned value of <var class="term">record</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)]].</td></tr> | ||
</td></tr> | |||
<tr><th> | <tr><th>record</th> | ||
<td> | <td>A <var>Record</var> object.</td></tr> | ||
</table> | |||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>You can use this property to display the locking for a given <var>Record</var> object. | <li>You can use this property to display the locking for a given <var>Record</var> object. | ||
Note the use of the <var>[[ToString]]</var> enumeration method | Note the use of the <var>[[Enumerations#ToString property|ToString]]</var> enumeration method | ||
to print the locking value: | to print the locking value: | ||
<p class="code"> %grouprec = new(1, 'TESTPROC', %e) | <p class="code">%grouprec = new(1, 'TESTPROC', %e) | ||
print %grouprec:lockstrength:toString | |||
</p> | </p> | ||
</ul> | </ul> | ||
==See also== | ==See also== | ||
{{Template:Record:LockStrength footer}} | {{Template:Record:LockStrength footer}} | ||
Latest revision as of 22:19, 2 September 2014
Return lock strength of Record (Record class)
This method returns a LockStrength enumeration to indicate the locking of the Record object.
Syntax
%lockStrength = record:LockStrength
Syntax terms
| %lockStrength | An Enumeration object of type LockStrength to contain the returned value of record'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). |
|---|---|
| record | A Record object. |
Usage notes
- You can use this property to display the locking for a given Record object.
Note the use of the ToString enumeration method
to print the locking value:
%grouprec = new(1, 'TESTPROC', %e) print %grouprec:lockstrength:toString