The IClearCase interface is the top-level interface that client code instantiates to access CAL objects representing the underlying Rational® ClearCase® objects.
Some IClearCase properties return populated collections of objects. For example, VOBs returns "all the VOBs in the current region". The IClearCase interface also has a number of empty collection properties which you can use to initialize collections of objects that have no content and that you can populate with items that you select. You can use the Add method on a collection object to populate the collection.
Sets whether the user interface of the client application is a Web browser
Gets the activity that is identified by this activity selector
Gets whether the current host is a Rational ClearCase LT installation
Gets whether the current host is a Rational ClearCase LT client installation
Gets whether the current host is a Rational ClearCase LT server installation
Checks for and acquires a Rational ClearCase license for the current user and host. Fails if license cannot be acquired.
Gets an empty CCBaselineComparison object for comparing baselines
Gets an empty CCCheckedOutFileQuery object for finding checked-out versions
Use ClearCase.Application.
Gets an empty collection of activities
Empty collection property
Property ActivitiesEmpty As CCActivities
Gets the activity that is identified by this activity selector
Read-only property
Property Activity(Selector As String) As CCActivity
ICCActivityPtr GetActivity( _bstr_t Selector);
Member of: IClearCase interface
Gets the activity that is associated with this version
Read-only property
Function ActivityOfVersion(pVersion As CCVersion) As CCActivity
ICCActivityPtr GetActivityOfVersion(ICCVersion* pVersion);
Member of: IClearCase interface
Gets an empty collection of attributes
Empty collection property
Property AttributesEmpty As CCAttributes
Gets an empty collection of attribute types
Empty collection property
Property AttributeTypesEmpty As CCAttributeTypes
Gets a particular baseline in the specified project VOB
Read-only property
Property Baseline(Selector As String) As CCBaseline
ICCBaselinePtr GetBaseline( _bstr_t Selector);
Member of: IClearCase interface
Gets an empty collection of baselines
Empty collection property
Property BaselinesEmpty As CCBaselines
Gets an empty collection of branches
Empty collection property
Property BranchesEmpty As CCBranches
Gets an empty collection of branch types
Empty collection property
Property BranchTypesEmpty As CCBranchTypes
Gets the checked-out file (or directory) with this path
Read-only property
Property CheckedOutFile(Path As String) As CCCheckedOutFile
ICCCheckedOutFilePtr GetCheckedOutFile( _bstr_t Path);
Member of: IClearCase interface
Gets an empty collection of checked-out versions
Empty collection property
Property CheckedOutFilesEmpty As CCCheckedOutFiles
Checks for and acquires a Rational ClearCase license for the current user and host. Fails if license cannot be acquired.
Method
Sub CheckLicense()
HRESULT CheckLicense();
It is not necessary to call this method to acquire a license prior to executing other CAL operations. Instantiation of any CAL object will do a license check and acquire a license if one is not already in use.
Member of: IClearCase interface
Gets a particular component in the specified project VOB
Read-only property
Property Component(Selector As String) As CCComponent
ICCComponentPtr GetComponent( _bstr_t Selector);
Member of: IClearCase interface
Gets an empty collection of components
Empty collection property
Property ComponentsEmpty As CCComponents
Gets an empty CCBaselineComparison object for comparing baselines
Method
Function CreateBaselineComparison As CCBaselineComparison
ICCBaselineComparisonPtr CreateBaselineComparison();
Member of: IClearCase interface
Gets an empty CCCheckedOutFileQuery object for finding checked-out versions
Method
Function CreateCheckedOutFileQuery As CCCheckedOutFileQuery
ICCCheckedOutFileQueryPtr CreateCheckedOutFileQuery();
Member of: IClearCase interface
Creates an element at the specified path
Method
Function CreateElement(Path As String, [ Comment As String = "" ], [ SetMaster As Boolean = False ], [ ElementTypeName As Variant ]), [MkPath As Boolean = False ] As CCCheckedOutFile
ICCCheckedOutFilePtr CreateElement( _bstr_t Path, _bstr_t Comment, VARIANT_BOOL SetMaster, const _variant_t& ElementTypeName = vtMissing, VARIANT_BOOL MkPath = False );
The file checked-out to your view as part of the CreateElement operation.
CreateElement is used to create both elements and directories (pass directory as ElementTypeName). CreateElement behaves like cleartool mkdir -nco when it creates directories and like cleartool mkdir -nco when it creates elements.
Member of: IClearCase interface
Gets the element that is associated with Path
Read-only property
Property Element(Path As String) As CCElement
ICCElementPtr GetElement( _bstr_t Path);
If you are using VOB-extended naming to specify the name of an element which is the VOB root directory, you must precede the extended naming symbol (by default, @@) with a period (.). For example, you must specify m:\view\vob\.@@ rather than m:\view\vob@@ or m:\view\vob\@@.
Member of: IClearCase interface
Gets an empty collection of elements
Empty collection property
Property ElementsEmpty As CCElements
Gets a particular folder in the specified project VOB
Read-only property
Property Folder(Selector As String) As CCFolder
ICCFolderPtr GetFolder( _bstr_t Selector);
Member of: IClearCase interface
Gets an empty collection of folders
Empty collection property
Property FoldersEmpty As CCFolders
Gets an empty collection of history records
Empty collection property
Property HistoryRecordsEmpty As CCHistoryRecords
Gets the specified hyperlink
Read-only property
Property Hyperlink(Selector As String) As CCHyperlink
ICCHyperlinkPtr GetHyperlink( _bstr_t Selector);
Member of: IClearCase interface
Gets an empty collection of hyperlinks
Empty collection property
Property HyperlinksEmpty As CCHyperlinks
Gets an empty collection of hyperlink types
Empty collection property
Property HyperlinkTypesEmpty As CCHyperlinkTypes
Gets whether the current host is a Rational ClearCase LT installation
Read-only property
Property IsClearCaseLT As Boolean
VARIANT_BOOL GetIsClearCaseLT();
Gets whether the current host is a Rational ClearCase LT client installation
Read-only property
Property IsClearCaseLTClient As Boolean
VARIANT_BOOL GetIsClearCaseLTClient();
Gets whether the current host is a Rational ClearCase LT server installation
Read-only property
Property IsClearCaseLTServer As Boolean
VARIANT_BOOL GetIsClearCaseLTServer();
Sets whether the user interface of the client application is a Web browser
Write-only property
Property IsWebGUI As Boolean
void PutIsWebGUI(VARIANT_BOOL NewIsWebGUI);
It is the intention that this property be used by clients whose user interface is a Web GUI running in a process on a remote machine, separate from the code that calls into CAL. For these clients, a trigger that was not disabled would be executed on the remote machine, which is probably not desirable. For this reason, setting IsWebGUI to True causes all Rational ClearCase triggers to fail.
Member of: IClearCase interface
Gets an empty collection of labels
Empty collection property
Property LabelsEmpty As CCLabels
Gets an empty collection of label types
Empty collection property
Property LabelTypesEmpty As CCLabelTypes
Gets an empty collection of locks
Empty collection property
Property LocksEmpty As CCLocks
Gets an object selector from a universal selector
Read-only property
String ObjectSelector(Object As UniversalSelector)
ObjectSelectorPtr ObjectSelector( _bstr_t UniversalSelector);
Member of: IClearCase interface
Gets a particular project in the specified project VOB
Read-only property
Property Project(Selector As String) As CCProject
ICCProjectPtr GetProject( _bstr_t Selector);
Member of: IClearCase interface
Gets an empty collection of projects
Empty collection property
Property ProjectsEmpty As CCProjects
Gets the specified project VOB
Read-only property
Property ProjectVOB(Identifier As String) As CCProjectVOB
ICCProjectVOBPtr GetProjectVOB( _bstr_t Identifier);
Member of: IClearCase interface
Gets the collection of project VOBs in the specified region
Read-only property
Property ProjectVOBs([ FailIfErrors As Boolean = True ], [ Region As String = "" ]) As CCProjectVOBs
ICCProjectVOBsPtr GetProjectVOBs( VARIANT_BOOL FailIfErrors, _bstr_t Region);
Member of: IClearCase interface
Gets an empty collection of project VOBs (PVOBs)
Empty collection property
Property ProjectVOBsEmpty As CCProjectVOBs
Causes all prompts to abort
Method
Sub SetAbortPrompts()
HRESULT SetAbortPrompts();
SetAbortPrompts ensures that all Rational ClearCase prompting code will fail. It is the intention that this method be used by clients whose user interface is running in a process on a remote machine, separate from the code that calls into CAL. For these clients, a prompt that was not disabled would go to the wrong machine.
Member of: IClearCase interface
Gets a particular stream in the specified project VOB
Read-only property
Property Stream(Selector As String) As CCStream
ICCStreamPtr GetStream( _bstr_t Selector);
Member of: IClearCase interface
Gets an empty collections of streams
Empty collection property
Property StreamsEmpty As CCStreams
Gets an empty collection of triggers
Empty collection property
Property TriggersEmpty As CCTriggers
Gets an empty collection of trigger types
Empty collection property
Property TriggerTypesEmpty As CCTriggerTypes
Gets the version that is associated with the path
Read-only property
Property Version(Path As Variant) As CCVersion
ICCVersionPtr GetVersion( const _variant_t& Path);
If you are using VOB-extended naming to specify the name of a version which is the VOB root directory, you must precede the extended naming symbol (by default, @@) with a period (.). For example, you must specify m:\view\vob\.@@\main\3 rather than m:\view\vob@@\main\3 or m:\view\vob\@@\main\3.
Member of: IClearCase interface
Gets an empty collection of versions
Empty collection property
Property VersionsEmpty As CCVersions
Gets the specified view
Read-only property
Property View([ Identifier As String = "" ]) As CCView
ICCViewPtr GetView( _bstr_t Identifier);
Member of: IClearCase interface
Gets the collection of views in the specified region
Read-only property
Property Views([ FailIfErrors As Boolean = True ], [ Region As String = "" ]) As CCViews
ICCViewsPtr GetViews( VARIANT_BOOL FailIfErrors, _bstr_t Region);
If FailIfErrors is set to True, any error messages encountered during collection initialization are returned through the normal COM error mechanism. If set to False, the collection will be initialized, but will not include those views for which there were errors. The error messages can be retrieved by calling ICCViews::InitErrors.
Gets an empty collection of views
Empty collection property
Property ViewsEmpty As CCViews
Gets the specified VOB
Read-only property
Property VOB(Identifier As String) As CCVOB
ICCVOBPtr GetVOB( _bstr_t Identifier);
Member of: IClearCase interface
Gets the collection of VOBs in the specified region
Read-only property
Property VOBs([ FailIfErrors As Boolean = True ], [ Region As String = "" ]) As CCVOBs
ICCVOBsPtr GetVOBS( VARIANT_BOOL FailIfErrors, _bstr_t Region);
If FailIfErrors is set to True, any error messages encountered during collection initialization are returned through the normal COM error mechanism. If set to False, the collection will be initialized, but will not include those VOBs for which there were errors. The error messages can be retrieved by calling ICCVOBs::InitErrors.
Gets an empty collection of VOBs
Empty collection property
Property VOBsEmpty As CCVOBs