Cancels the check-out reservation held on this document or version series by deleting the reservation object associated with it. Any changes made to the reservation object are lost. If the reservation object is an exclusive reservation (the object's
ReservationType
property is set to
EXCLUSIVE
), the user must be the reservation owner (the reservation owner's name is the value of the reservation object's
Owner
property) or have both
WRITE_OWNER
and
DELETE
access rights. Note that this method is provided only as a convenience method for canceling a checkout; all it does is delete the reservation version held by the document or version series from which it is called.
After a document's reservation object is deleted, the Content Engine performs the following steps on the reserved document version:
- Sets the
IsReserved
property to false
. - Sets the
ReservationType
property to null
.
An error occurs if the document is not checked out or is a newly created object that has never been checked in.
Namespace: FileNet.Api.CoreAssembly: FileNet.Api (in filenet.api.dll)
Syntax
Visual Basic (Declaration) |
---|
Function CancelCheckout() As IVersionable |
Return Value
A Versionable
object specifying the reservation object for which a delete pending action has been created. You must call this Versionable
object’s Save
method to compete the cancellation of the checkout.
See Also