Equinox Online Help - Language Reference - A to Z

Home

LockRetry

Applies to
SyntaxLockRetry [Interval1Expression] [, Interval2Expression] [, RelatedLockRetryExpression]
Action[Statement] Sets the timeout duration(s) against a lock request.
ScopeUsable anywhere.
Notes

When a lock request fails, Equinox automatically retries (once every second) until a set period of time has elapsed. If the request is still failing then a dialog is displayed (with a Cancel button). Equinox continues to retry the lock (every two seconds), until a second set period of time has elapsed. During this second period, you may cancel the operation by choosing the Cancel button on the dialog. If the request is still failing after the second period, then the operation is aborted.

This statement allows you to set the duration of the two retry periods. The first argument, Interval1Expression, specifies the duration of the first (silent) period and Interval2Expression specifies the second (interactive) period. Both arguments can take the following values:

  • -3 Remains unchanged
  • -2 Reset to default (see below)
  • -1 Set to infinity
  • 0 Set to zero
  • >0 Set to the specified number of seconds

If either argument is omitted, it remains unchanged. Note that by default, the silent retry period is set to 0 and the interactive retry period is set to 300.

The third argument, RelatedLockRetryExpression, sets the Related Lock Retry value. This value specifies what happens when a lock fails on a hierarchically or relationally linked record. This can occur on a form, eg where a group contains editable fields from a related table. When you edit the current record, the related record is also locked.

If the related record is already locked and the Related Lock Retry value is set to True (its default value) then the lock retry periods execute as normal. However, if it has been set to False then both retry periods are aborted, as if they were set to zero.

CategoryLocking
See Also ApplicationState, IsLockedByMe, Lock, LockApplication, LockRelated, RetryInterval1, RetryInterval2, Unlock, UnlockApplication
Example

The effects of the following example statements are described in the adjacent comments:

LockRetry 6,10 | sets silent period To 6, interactive To 10
LockRetry -2,-2 | sets both periods To defaults (0 & 300)
LockRetry 0,0 | sets both periods To 0 - no retry
LockRetry 4 | sets silent period To 4
LockRetry ,5 | sets interactive period To 5
LockRetry 5,0 | sets silent period To 5, interactive To 0
LockRetry -1 | no timeout
LockRetry 5, -1 | sets silent To 5, no interactive timeout