ICancelCheckoutCmd Interface

The ICancelCheckoutCmd interface is used to initialize the data contained in the CancelCheckout command component, which silently cancels the checkout operation for a specified object store item. Using this interface, the client application specifies the item for which to cancel the checkout operation. After the checkout operation has been cancelled, the client application is responsible for deleting the local file, if desired.

After the CancelCheckout command has been executed by calling IAppIntCmd::Invoke, a CancelCheckout response component is returned. Client applications may interact with the response component via the standard IAppIntRsp interface.

COM Class ID

coclass CancelCheckoutCmd {
[default] interface ICancelCheckoutCmd;
interface IAppIntCmd;
}; coclass CancelCheckoutRsp {
[default] interface IAppIntRsp;
};

Reference

DLL FnAppIntCancelCheckoutCmd.dll
See Also ICheckoutListCmd Interface

Methods

The ICancelCheckoutCmd interface defines one method:

Method Description
Initialize

Initializes the CancelCheckout command by specifying the object store item, for which to cancel the checkout operation.

Example

The following is a fragment from the complete example for the CancelCheckout command.

   ...
   // Instantiate the custom CancelCheckout command component
   ICancelCheckoutCmdPtr spICancelCheckoutCmd;
hResult = spICancelCheckoutCmd.CreateInstance(__uuidof(CancelCheckoutCmd));
if (FAILED(hResult)) {
std::cout << "Could not create the CancelCheckout command component.\n"; _ASSERTE(0);
} ...