dobj_checkin
dobj_checkin (dobj[, ud])
Checks in the locked document object possessing the document object handle of dobj. To properly update the revised document in the repository, you must save the object before calling dobj_checkin. All revisions to the document object are then written to the repository.
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 check-in fails, the function sets $main::ioerr and returns a zero (0). If the check-in is successful, the function returns a document object handle. Note that the returned document object handle may not be the same document object handle that was passed to the function.
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_checkin(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