Arbortext Command Language > Repository API > dobj_unlock
  
dobj_unlock
dobj_unlock (dobj[, ud])
Unlocks, in the repository, the object with the dobj ACL document object handle. Note that this function performs the unlock without performing a check-in.
The ud parameter can be used to pass user defined information to a callback; strings must match the adapter encoding. Refer to Repository API Callback functions for more information on using callbacks with the Repository API functions.
If dobj is invalid, or the operation fails, the function sets $main::ioerr and returns a zero (0). If the operation is successful, the function returns the document handle of the unlocked object.
The dobj_close function must be called to close the document object after it has been processed. However, the returned document object may differ from the one passed to the function. The document object can be closed by implementing the following sample code.
local new_dobj = dobj_unlock(dobj);
if (dobj_valid(new_dobj))
{
# A new dobj was returned. Release the old one and
# start using the new one.
dobj_close(dobj);
dobj = new_dobj;
}
Related Topics
Repository API callback functions