Equinox Online Help - Language Reference - A to Z
LockRetry |
|
---|---|
Applies to | |
Syntax | LockRetry [Interval1Expression] [, Interval2Expression] [, RelatedLockRetryExpression] |
Action | [Statement] Sets the timeout duration(s) against a lock request. |
Scope | Usable 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:
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. |
Category | Locking |
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 |