HSDK Class Descriptions › CaVersionChooser

CaVersionChooser

CaVersionChooser cannot be instantiated directly. The CaVersionChooser object can only be retrieved from the CaContext after the project and state have been correctly added to context.

The Version Chooser provides a mechanism to select a set of versions based upon filtered criteria. Each Version Chooser attribute adds an additional restriction on the selected version set. The resulting version list is available to CaDeleteVersion, CaCheckin and CaCheckout processes in the current context. A list of attributes from the selected versions can be retrieved in the form of a CaContainer or a CaVersionList.

Usage

• Set the Project and State Context.

  Note: If the State is a Snapshot State then set a Snapshot View in the current context. If the State is not a Shapshot State and there is no Working View then the Version Chooser is not active.

• Set the desired Version Chooser attributes.
• Invoke the Execute function.

Public Methods

• Clear
• SetParentPath
• SetExcludePaths
• RemoveVersionFromList
• SetItemObjId
• SetItemName
• SetItemPackageObjId
• SetPackageObjId
• SetRecursive
• SetBranchOption
• SetVersionNumber
• SetVersionOption
• SetVersionItemOption
• SetVersionStatusOption
• SetVersionDateOption
• SetVersionObjIdSetFromDate
• SetToDate
• GetVersionList
• GetVersionListAsList
• Execute

More information:

• HSDK Programming Fundamentals
• CaContext
• CaContainer
• CaCheckin
• CaCheckout
• CaDeleteVersion