hw_api::lock
(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)
hw_api::lock — Locks an object
Description
$parameter
)Locks an object for exclusive editing by the user calling this function. The object can be only unlocked by this user or the system user.
Parameters
-
parameter -
The parameter array contains the required element 'objectIdentifier' and the optional parameters 'mode' and 'objectquery'.
'mode' determines how an object is locked.
HW_API_LOCK_NORMALmeans, an object is locked until it is unlocked.HW_API_LOCK_RECURSIVEis only valid for collection and locks all objects within the collection and possible subcollections.HW_API_LOCK_SESSIONmeans, an object is locked only as long as the session is valid.
Return Values
Returns TRUE on success or FALSE on failure.
0044 203 3971 555 (UK)