clear-locks Command

The clear-locks BASIC program clears all locks, or specific locks according to the options provided. When used with the i option, an optional host may be specified to release all item locks residing on a remote server.

NOTE

  • When a lock is cleared, an entry indicating the type of lock that was cleared is logged to the errors file.

  • If clear-locks is run without any parameters specified, it is no longer possible to stack data into the command.

 

WARNING

Supports additional options for FSI item locks. FSI group locks cannot be listed or cleared from TCL. You must use the monitor.

Syntax

clear-locks {host}{(options}

Parameter(s)

options

a

Clears client Transaction Log locks only.

b

Clears all BASIC locks.

c

Clears server Transaction Log locks only.

f{fid}

Clears all group and item locks for a specific frame-ID, specified as a decimal number. fid must be the first frame-ID of a group to clear all item locks in the group. If a FCB is specified, all item locks in the entire file are cleared.

NOTE—The f option indicates that the number immediately following it is a frame-ID. Without the f option, the number is interpreted as a port number.

g{f{fid}}

Clears all group locks and ignores item locks for a specific frame-ID, specified as a decimal number see note under f option).

i{f{fid}}

Clears all item locks, and ignores group locks, for a specific frame-ID, specified as a decimal number see note under f option).

NOTE—The i option will not work with a specific port number or f<fid>.

m

Clears all phantom locks.

o{f{fid}}

Clears all group read-only locks for a specific frame-ID, specified as a decimal number (see note under f option).

q

Clears all spooler locks.

r{f{fid}}

Clears all group retrieval locks for a specific frame-ID, specified as a decimal number (see note under f option).

u{f{fid}}

Clears all group update locks for a specific frame-ID, specified as a decimal number see note under f option).

s

Clears all system locks.

t

Clears Transaction Log locks.

Example(s)

Clears all group locks for port 3.

clear-locks (g3

Clears all group locks for decimal frame 12345.

clear-locks (gf12345

Clears all group and item locks for the group starting at FID 12345.

clear-locks (f12345

Clears all item locks for the group starting at FID 12345.

clear-locks (if12345

Behaves as the same as clear-locks (f12345 because both the i and g options are specified.

clear-locks (igf12345

See Also

clear-basic-locks Macro, hosts File, lock Statement, Locking Scheme, System Privileges, unlock Statement, unlock-file Command, unlock-group Command, unlock-item Command