Guardian Procedure Calls Reference Manual

FILE_GETLOCKINFO_ Procedure
Summary
Syntax for C Programmers
Syntax for TAL Programmers
Parameters
Returned Value
Considerations
OSS Considerations
Example
Summary
The FILE_GETLOCKINFO_ procedure obtains information about locks (held or pending) on a local
disk file or on a set of files on a local disk volume. Each call returns information about one lock
and as many holders or waiters as permitted by the caller's request. A succession of calls can
obtain information about all the locks on a file or volume, or all the locks owned by a process or
transaction.
Syntax for C Programmers
#include <cextdecs(FILE_GETLOCKINFO_)>
short FILE_GETLOCKINFO_ ( const char *name
,short length
,[ short *processhandle ]
,[ short *transid ]
,short *control
,short *lock-descr
,short lock-descr-length
,short *participants
,short max-participants
,[ char *locked-name ]
,[ short maxlen ]
,[ short *locked-name-length ] );
• The parameter maxlen specifies the maximum length in bytes of the character string pointed
to by locked-name, the actual length of which is returned by locked-name-length. All
three of these parameters must either be supplied or be absent.
Syntax for TAL Programmers
error := FILE_GETLOCKINFO_ ( name:length ! i:i
,[ processhandle ] ! i
,[ transid ] ! i
,control ! i,o
,lock-descr ! o
,lock-descr-length ! i
,participants ! o
,max-participants ! i
,[ locked-name:maxlen ] ! o:i
,[ locked-name-length ] ); ! o
434 Guardian Procedure Calls (F)