Difference between revisions of "LOCKINFO()"
From Recital Documentation Wiki
Yvonnemilne (Talk | contribs) |
Yvonnemilne (Talk | contribs) |
||
| (One intermediate revision by one user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ==Purpose== | |
| + | Function to return lock information about a specified file | ||
| + | |||
| + | |||
| + | ==Syntax== | ||
| + | LOCKINFO(<expC>) | ||
| + | |||
| + | |||
| + | ==See Also== | ||
| + | [[ISLOCKED()]], [[LKSYS()]], [[SET EXCLUSIVE]] | ||
| + | |||
| + | |||
| + | ==Description== | ||
| + | The LOCKINFO() function returns lock information about the specified file named in <expC>, which can be a table or index file. If there are no locks active on the specified file or it does not exist, LOCKINFO() returns an empty string. If there are locks active on the file, LOCKINFO() returns a string with the following information about the lock(s): | ||
| + | |||
| + | * name of user | ||
| + | * id of process | ||
| + | * tty connection | ||
| + | * mode: shared / exclusive | ||
| + | |||
| + | Information is returned about one process, although more than one process may have locks on the file. | ||
| + | |||
| + | ==Example== | ||
| + | <code lang="recital"> | ||
| + | ? lockinfo("/opt/recital/data/southwind/example.dbf") | ||
| + | root(8053) /dev/pts/3 shared | ||
| + | ? lockinfo("/opt/recital/data/southwind/example.dbx") | ||
| + | root(8053) /dev/pts/3 shared | ||
| + | </code> | ||
| + | |||
| + | |||
| + | ==Products== | ||
| + | Recital Server, Recital | ||
| + | [[Category:Documentation]] | ||
| + | [[Category:Functions]] | ||
| + | [[Category:Table Basics]] | ||
| + | [[Category:Table Basics Functions]] | ||
Latest revision as of 14:15, 5 July 2011
Purpose
Function to return lock information about a specified file
Syntax
LOCKINFO(<expC>)
See Also
ISLOCKED(), LKSYS(), SET EXCLUSIVE
Description
The LOCKINFO() function returns lock information about the specified file named in <expC>, which can be a table or index file. If there are no locks active on the specified file or it does not exist, LOCKINFO() returns an empty string. If there are locks active on the file, LOCKINFO() returns a string with the following information about the lock(s):
- name of user
- id of process
- tty connection
- mode: shared / exclusive
Information is returned about one process, although more than one process may have locks on the file.
Example
? lockinfo("/opt/recital/data/southwind/example.dbf") root(8053) /dev/pts/3 shared ? lockinfo("/opt/recital/data/southwind/example.dbx") root(8053) /dev/pts/3 shared
Products
Recital Server, Recital
