ICheckinCmd2 Interface

NOTE Customers should only use the ICheckinCmd2 interface in new development, as well as replace existing implementations of the ICheckinCmd interface with ICheckinCmd2.

The ICheckinCmd2 interface is used to initialize the data contained in the Checkin command component, which launches the FileNet Workplace Checkin Wizard to allow the user to checkin an item into an object store. Using this interface, the client application can customize the dialog title, as well as identify the item to check-in via the name and directory location of the file on the local machine, the version object for the item, and the XML for the item properties.

After the Checkin command has been executed by calling IAppIntCmd::Invoke, a Checkin response component is returned. The response component contains specific Checkin command data that is accessible through the ICheckinRsp interface.

COM Class ID

coclass CheckinCmd {
[default] interface ICheckinCmd2;
interface IAppIntCmd;
};

Reference

DLL FnAppIntCheckinCmd.dll
See Also ICheckinRsp Interface

Methods

The ICheckinCmd2 interface defines one method:

Method Description
Initialize2

Allows the specification of the dialog title, the name and directory location of the file to be checked-in on the local machine, the version object for the item, and the XML for the item properties.

Example

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

   ...
   // Instantiate the custom Checkin command component
   ICheckinCmd2Ptr spICheckinCmd2;
hResult = spICheckinCmd2.CreateInstance(__uuidof(CheckinCmd));
if (FAILED(hResult)) {
std::cout << "Could not create the Checkin command component.\n"; _ASSERTE(0);
} ...