Guardian Procedure Calls Reference Manual

Parameters
name:length
input:input
STRING .EXT:ref:*, INT:value
specifies the name of the disk file or volume for which lock information is to be retrieved. The
value of name must be exactly length bytes long and must be a valid disk file name or volume
name; if processhandle or transid are specified, it must be a volume name. If the supplied
name is partially qualified, it is resolved using the contents of the =_DEFAULTS DEFINE. The
specified disk file or volume must be on the local system. The value of name cannot be a DEFINE
name.
processhandle
input
INT .EXT:ref:10
if present and not null, is the process handle of the process that is holding or waiting for the
locks about which information is to be returned. A nonnull value of processhandle cannot
be supplied when transid is supplied. A null processhandle has -1 in each word.
transid
input
INT .EXT:ref:4
if present and not null, is the transaction identifier of the transaction that is holding or waiting
for the locks about which information is to be returned. A nonnull value of transid cannot
be supplied when processhandle is supplied. A null transid contains 0 in each word.
control
input, output
INT .EXT:ref:10
is an array of words used by FILE_GETLOCKINFO_ to control a succession of calls to the
procedure. When making the first of a series of calls, you must initialize word 0 of this array
to the value 0. On subsequent calls, pass the value of control that was returned by the
previous call.
lock-descr
output
INT .EXT:ref:*
points to a buffer that, on return, contains a block of words describing a lock.
lock-descr-length specifies the size in bytes of the buffer. If the buffer is not large enough
to contain the information, an error value of 563 (buffer too small) is returned and the contents
of lock-descr are undefined.
The information is returned in this format:
Lock type. 0 indicates a file lock; 1 indicates a record lock.[0]
Flags. The bits are:[1]
Indicates a generic lock<0> = 1
(reserved)<1:15>
The number of participants (the number of holders and waiters for the lock).[2]
Record specifier (4 bytes) if the lock is a record lock on a format 1 file that is not key-sequenced; undefined
otherwise.
[3:4]
FILE_GETLOCKINFO_ Procedure 435