ddLockGetStatus
ddLockGetStatus(
b_lockId
)
=> x_sysId t_type x_value t_userName t_userHost t_fileHost t_filePath
Description
Retrieves frequently needed information from the lock table: The lock-system ID, type, and value and the holder's user name and hostid.
Arguments
|
b_lockId
|
ID of a locked file as returned from ddLockPath.
|
Value Returned
|
x_sysId
|
Always returns 0.
|
|
t_type
|
Lock-system type of the lock.
Valid Values:
"Empty" - there is no lock
"Write" / "Exclusive" - for CLS these mean the same thing, the file is locked for editing.
"Unknown" - indeterminately locked, which means that edit lock details cannot be retrieved. For example, when the edit lock file is not readable.
|
|
x_value
|
Always returns 0.
|
|
t_userName
|
If the lock type is anything except "Write" or "Exclusive", the return value is "UNKNOWN".
|
|
t_userHost
|
User name of host running user process. If the lock type is anything except "Write" or "Exclusive", the return value is "UNKNOWN".
|
|
t_fileHost
|
Always returns "UNKNOWN"
|
|
t_filePath
|
Path locked.
|
Examples
ddLockGetStatus( myFileLock ) => (0 "Write" 0 "guest" "big_sun" "UNKNOWN" "/tmp/my.file" )
Return to top
