HSDK Class Descriptions › CaCheckin › bool SetItemOption(HINT32 iOption)

bool SetItemOption(HINT32 iOption)

Sets the Item Option for this process.

Note: The following are the allowable values for the Item Option. They are defined in an include file built into the project.

• CI_FILTER_NEW_OR_EXISTING_ITEMS-When this option is selected, all selected files are checked in if they are reserved by the package or did not previously exist in the repository. This filter does not require the corresponding item to be in the current view. However, if it is in the current view, then it must have a reserved version in the current package.
• CI_FILTER_NEW_ITEMS_ONLY-This option limits the check-in to files that do not have corresponding items in the current view. If the item has been removed from the current view, then the file can be checked in using this filter.
• If the corresponding item was renamed in the current project, then the file cannot be checked in. The file must be renamed before it can be checked in.
• CI_FILTER_EXISTING_ITEMS_ONLY-This option limits the check-in to files that have corresponding items reserved by the package. Any files without corresponding items are skipped. This filter can be used to prevent the existence of unwanted files, such as temporary files or templates, in your repository.

Owning Class

CaCheckin

Arguments

HINT32 iOption-the Item Option

Return Value

True if success, false if fail

Example

CaCheckin& rCheckin = rContext.GetCheckin(); bool bResult = rCheckin. SetItemOption (CI_FILTER_NEW_OR_EXISTING_ITEMS);

More information:

HSDK Programming Fundamentals

CaContext

HINT32 GetItemOption(void)