IClearCase interface

Description

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.

Inheritance

IClearCase inherits from IDispatch.

Empty collection properties

ActivitiesEmpty

Gets an empty collection of activities

AttributesEmpty

Gets an empty collection of attributes

AttributeTypesEmpty

Gets an empty collection of attribute types

BaselinesEmpty

Gets an empty collection of baselines

BranchesEmpty

Gets an empty collection of branches

BranchTypesEmpty

Gets an empty collection of branch types

CheckedOutFilesEmpty

Gets an empty collection of checked-out versions

ComponentsEmpty

Gets an empty collection of components

ElementsEmpty

Gets an empty collection of elements

FoldersEmpty

Gets an empty collection of folders

HistoryRecordsEmpty

Gets an empty collection of history records

HyperlinksEmpty

Gets an empty collection of hyperlinks

HyperlinkTypesEmpty

Gets an empty collection of hyperlink types

LabelsEmpty

Gets an empty collection of labels

LabelTypesEmpty

Gets an empty collection of label types

LocksEmpty

Gets an empty collection of locks

ProjectsEmpty

Gets an empty collection of projects

ProjectVOBsEmpty

Gets an empty collection of project VOBs (PVOBs)

StreamsEmpty

Gets an empty collections of streams

TriggersEmpty

Gets an empty collection of triggers

TriggerTypesEmpty

Gets an empty collection of trigger types

VersionsEmpty

Gets an empty collection of versions

ViewsEmpty

Gets an empty collection of views

VOBsEmpty

Gets an empty collection of VOBs

Write-only properties

IsWebGUI

Sets whether the user interface of the client application is a Web browser

Read-only properties

Activity

Gets the activity that is identified by this activity selector

ActivityOfVersion

Gets the activity that is associated with this version

Baseline

Gets a particular baseline in the specified project VOB

CheckedOutFile

Gets the checked-out file (or directory) with this path

Component

Gets a particular component in the specified project VOB

Element

Gets the element that is associated with Path

Folder

Gets a particular folder in the specified project VOB

Hyperlink
IsClearCaseLT

Gets whether the current host is a Rational ClearCase LT installation

IsClearCaseLTClient

Gets whether the current host is a Rational ClearCase LT client installation

IsClearCaseLTServer

Gets whether the current host is a Rational ClearCase LT server installation

ObjectSelector

Gets an object selector from a universal selector

Project

Gets a particular project in the specified project VOB

ProjectVOB

Gets the specified project VOB

ProjectVOBs

Gets the collection of project VOBs in the specified region

Stream

Gets a particular stream in the specified project VOB

Version

Gets the version that is associated with the path

View

Gets the specified view

Views

Gets the collection of views in the specified region

VOB

Gets the specified VOB

VOBs

Gets the collection of VOBs in the specified region

Methods

CheckLicense

Checks for and acquires a Rational ClearCase license for the current user and host. Fails if license cannot be acquired.

CreateBaselineComparison

Gets an empty CCBaselineComparison object for comparing baselines

CreateCheckedOutFileQuery

Gets an empty CCCheckedOutFileQuery object for finding checked-out versions

CreateElement

Creates an element at the specified path

SetAbortPrompts

Causes all prompts to abort

Examples

Creation

Use ClearCase.Application.

ActivitiesEmpty

Gets an empty collection of activities

Category

Empty collection property

VB syntax

Property ActivitiesEmpty As CCActivities

Visual C++ syntax

ICCActivitiesPtr GetActivitiesEmpty();

Member of: IClearCase interface

Activity

Gets the activity that is identified by this activity selector

Category

Read-only property

VB syntax

Property Activity(Selector As String) As CCActivity

Visual C++ syntax

ICCActivityPtr GetActivity(
     _bstr_t Selector);
Parameter
Description
Selector
An identifier of the form [activity:]activity-name[@vob-selector] to specify the activity. vob-selector is optional only when you are cd'ed to the UCM project VOB that contains the activity.

Member of: IClearCase interface

ActivityOfVersion

Gets the activity that is associated with this version

Category

Read-only property

VB syntax

Function ActivityOfVersion(pVersion As CCVersion) As CCActivity

Visual C++ syntax

ICCActivityPtr GetActivityOfVersion(ICCVersion* pVersion);
Parameter
Description
pVersion
The version to associate with its activity.

Member of: IClearCase interface

AttributesEmpty

Gets an empty collection of attributes

Category

Empty collection property

VB syntax

Property AttributesEmpty As CCAttributes

Visual C++ syntax

ICCAttributesPtr GetAttributesEmpty();

Member of: IClearCase interface

AttributeTypesEmpty

Gets an empty collection of attribute types

Category

Empty collection property

VB syntax

Property AttributeTypesEmpty As CCAttributeTypes

Visual C++ syntax

ICCAttributeTypesPtr GetAttributeTypesEmpty();

Member of: IClearCase interface

Baseline

Gets a particular baseline in the specified project VOB

Category

Read-only property

VB syntax

Property Baseline(Selector As String) As CCBaseline

Visual C++ syntax

ICCBaselinePtr GetBaseline(
     _bstr_t Selector);
Parameter
Description
Selector
An identifier of the form [baseline:]baseline-name[@vob-selector] to specify the baseline. vob-selector is optional only when you are cd'ed to the UCM project VOB that contains the baseline.

Member of: IClearCase interface

BaselinesEmpty

Gets an empty collection of baselines

Category

Empty collection property

VB syntax

Property BaselinesEmpty As CCBaselines

Visual C++ syntax

ICCBaselinesPtr GetBaselinesEmpty();

Member of: IClearCase interface

BranchesEmpty

Gets an empty collection of branches

Category

Empty collection property

VB syntax

Property BranchesEmpty As CCBranches

Visual C++ syntax

ICCBranchesPtr GetBranchesEmpty();

Member of: IClearCase interface

BranchTypesEmpty

Gets an empty collection of branch types

Category

Empty collection property

VB syntax

Property BranchTypesEmpty As CCBranchTypes

Visual C++ syntax

ICCBranchTypesPtr GetBranchTypesEmpty();

Member of: IClearCase interface

CheckedOutFile

Gets the checked-out file (or directory) with this path

Category

Read-only property

VB syntax

Property CheckedOutFile(Path As String) As CCCheckedOutFile

Visual C++ syntax

ICCCheckedOutFilePtr GetCheckedOutFile(
     _bstr_t Path);
Parameter
Description
Path
A path to the checked-out file.

Member of: IClearCase interface

CheckedOutFilesEmpty

Gets an empty collection of checked-out versions

Category

Empty collection property

VB syntax

Property CheckedOutFilesEmpty As CCCheckedOutFiles

Visual C++ syntax

ICCCheckedOutFilesPtr GetCheckedOutFilesEmpty();

Member of: IClearCase interface

CheckLicense

Checks for and acquires a Rational ClearCase license for the current user and host. Fails if license cannot be acquired.

Category

Method

VB syntax

Sub CheckLicense()

Visual C++ syntax

HRESULT CheckLicense();

Remarks

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

Component

Gets a particular component in the specified project VOB

Category

Read-only property

VB syntax

Property Component(Selector As String) As CCComponent

Visual C++ syntax

ICCComponentPtr GetComponent(
     _bstr_t Selector);
Parameter
Description
Selector
An identifier of the form [component:]component-name[@vob-selector] to specify the component. vob-selector is optional only when you are cd'ed to the UCM project VOB that contains the component.

Member of: IClearCase interface

ComponentsEmpty

Gets an empty collection of components

Category

Empty collection property

VB syntax

Property ComponentsEmpty As CCComponents

Visual C++ syntax

ICCComponentsPtr GetComponentsEmpty();

Member of: IClearCase interface

CreateBaselineComparison

Gets an empty CCBaselineComparison object for comparing baselines

Category

Method

VB syntax

Function CreateBaselineComparison As CCBaselineComparison

Visual C++ syntax

ICCBaselineComparisonPtr CreateBaselineComparison();

Member of: IClearCase interface

CreateCheckedOutFileQuery

Gets an empty CCCheckedOutFileQuery object for finding checked-out versions

Category

Method

VB syntax

Function CreateCheckedOutFileQuery As CCCheckedOutFileQuery

Visual C++ syntax

ICCCheckedOutFileQueryPtr CreateCheckedOutFileQuery();

Member of: IClearCase interface

CreateElement

Creates an element at the specified path

Category

Method

VB syntax

Function CreateElement(Path As String, [ Comment As String = "" ], [ SetMaster As Boolean = False ], [ ElementTypeName As Variant ]), [MkPath As Boolean = False ] As CCCheckedOutFile

Visual C++ syntax

ICCCheckedOutFilePtr CreateElement(
     _bstr_t Path,
     _bstr_t Comment,
     VARIANT_BOOL SetMaster,
     const _variant_t& ElementTypeName = vtMissing,
     VARIANT_BOOL MkPath = False );
Parameter
Description
Path
A path that specifies where to create the element.
Comment
Optional in Visual Basic. A comment to associate with the history record for this CreateElement operation.
SetMaster
Optional in Visual Basic. True to assign mastership of the new element's main branch to the local replica; False to assign mastership of the main branch to the VOB replica that masters the branch type main (like cleartool mkelem -master).
ElementTypeName
Optional. String that contains the name of the element type. For information on the predefined element types, see the mkeltype reference page .
MkPath
Optional in Visual Basic. False (default) to fail if parent directory is not a checked out directory element. True to checkout and create directory elements that are specified in path argument (like cleartool mkelem -mkpath).

Return value

The file checked-out to your view as part of the CreateElement operation.

Remarks

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

Element

Gets the element that is associated with Path

Category

Read-only property

VB syntax

Property Element(Path As String) As CCElement

Visual C++ syntax

ICCElementPtr GetElement(
     _bstr_t Path);
Parameter
Description
Path
A path to the element, which can be specified with or without the extended naming symbol (by default, @@).

Remarks

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

ElementsEmpty

Gets an empty collection of elements

Category

Empty collection property

VB syntax

Property ElementsEmpty As CCElements

Visual C++ syntax

ICCElementsPtr GetElementsEmpty();

Member of: IClearCase interface

Folder

Gets a particular folder in the specified project VOB

Category

Read-only property

VB syntax

Property Folder(Selector As String) As CCFolder

Visual C++ syntax

ICCFolderPtr GetFolder(
     _bstr_t Selector);
Parameter
Description
Selector
An identifier of the form [folder:]folder-name[@vob-selector] to specify the folder. vob-selector is optional only when you are cd'ed to the UCM project VOB that contains the folder.

Member of: IClearCase interface

FoldersEmpty

Gets an empty collection of folders

Category

Empty collection property

VB syntax

Property FoldersEmpty As CCFolders

Visual C++ syntax

ICCFoldersPtr GetFoldersEmpty();

Member of: IClearCase interface

HistoryRecordsEmpty

Gets an empty collection of history records

Category

Empty collection property

VB syntax

Property HistoryRecordsEmpty As CCHistoryRecords

Visual C++ syntax

ICCHistoryRecordsPtr GetHistoryRecordsEmpty();

Member of: IClearCase interface

HyperlinksEmpty

Gets an empty collection of hyperlinks

Category

Empty collection property

VB syntax

Property HyperlinksEmpty As CCHyperlinks

Visual C++ syntax

ICCHyperlinksPtr GetHyperlinksEmpty();

Member of: IClearCase interface

HyperlinkTypesEmpty

Gets an empty collection of hyperlink types

Category

Empty collection property

VB syntax

Property HyperlinkTypesEmpty As CCHyperlinkTypes

Visual C++ syntax

ICCHyperlinkTypesPtr GetHyperlinkTypesEmpty();

Member of: IClearCase interface

IsClearCaseLT

Gets whether the current host is a Rational ClearCase LT installation

Category

Read-only property

VB syntax

Property IsClearCaseLT As Boolean

Visual C++ syntax

VARIANT_BOOL GetIsClearCaseLT();

IsClearCaseLTClient

Gets whether the current host is a Rational ClearCase LT client installation

Category

Read-only property

VB syntax

Property IsClearCaseLTClient As Boolean

Visual C++ syntax

VARIANT_BOOL GetIsClearCaseLTClient();

IsClearCaseLTServer

Gets whether the current host is a Rational ClearCase LT server installation

Category

Read-only property

VB syntax

Property IsClearCaseLTServer As Boolean

Visual C++ syntax

VARIANT_BOOL GetIsClearCaseLTServer();

IsWebGUI

Sets whether the user interface of the client application is a Web browser

Category

Write-only property

VB syntax

Property IsWebGUI As Boolean

Visual C++ syntax

void PutIsWebGUI(VARIANT_BOOL NewIsWebGUI);
Parameter
Description
NewIsWebGUI
Visual C++ only. True to specify that the client application's user interface is a Web browser; False to specify the client application's user interface is not a Web browser.

Remarks

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

LabelsEmpty

Gets an empty collection of labels

Category

Empty collection property

VB syntax

Property LabelsEmpty As CCLabels

Visual C++ syntax

ICCLabelsPtr GetLabelsEmpty();

Member of: IClearCase interface

LabelTypesEmpty

Gets an empty collection of label types

Category

Empty collection property

VB syntax

Property LabelTypesEmpty As CCLabelTypes

Visual C++ syntax

ICCLabelTypesPtr GetLabelTypesEmpty();

Member of: IClearCase interface

LocksEmpty

Gets an empty collection of locks

Category

Empty collection property

VB syntax

Property LocksEmpty As CCLocks

Visual C++ syntax

ICCLocksPtr GetLocksEmpty();

Member of: IClearCase interface

ObjectSelector

Gets an object selector from a universal selector

Category

Read-only property

VB syntax

String ObjectSelector(Object As UniversalSelector)

Visual C++ syntax

ObjectSelectorPtr ObjectSelector(
     _bstr_t UniversalSelector);
Parameter
Description
ObjectSelector
A selector in the form object-type:object-name@vob-tag
UniversalSelector
A selector in the form oid:object-oid@\vobuuid:vob-family-uuid.

Member of: IClearCase interface

Project

Gets a particular project in the specified project VOB

Category

Read-only property

VB syntax

Property Project(Selector As String) As CCProject

Visual C++ syntax

ICCProjectPtr GetProject(
     _bstr_t Selector);
Parameter
Description
Selector
An identifier of the form [project:]project-name[@vob-selector] to specify the project. vob-selector is optional only when you are cd'ed to the UCM project VOB that contains the project.

Member of: IClearCase interface

ProjectsEmpty

Gets an empty collection of projects

Category

Empty collection property

VB syntax

Property ProjectsEmpty As CCProjects

Visual C++ syntax

ICCProjectsPtr GetProjectsEmpty();

Member of: IClearCase interface

ProjectVOB

Gets the specified project VOB

Category

Read-only property

VB syntax

Property ProjectVOB(Identifier As String) As CCProjectVOB

Visual C++ syntax

ICCProjectVOBPtr GetProjectVOB(
     _bstr_t Identifier);
Parameter
Description
Identifier
A path in the project VOB, a VOB tag, or a VOB family UUID.

Member of: IClearCase interface

ProjectVOBs

Gets the collection of project VOBs in the specified region

Category

Read-only property

VB syntax

Property ProjectVOBs([ FailIfErrors As Boolean = True ], [ Region As String = "" ]) As CCProjectVOBs

Visual C++ syntax

ICCProjectVOBsPtr GetProjectVOBs(
     VARIANT_BOOL FailIfErrors,
     _bstr_t Region);
Parameter
Description
FailIfErrors
Optional in Visual Basic. True to fail the collection initialization if errors occur; False to continue even in the presence of errors.
Region
Optional in Visual Basic. The region from which to get the project VOB tags. If not specified, gets the project VOB tags from the default region. Because only one region is used in Rational ClearCase LT, you should not specify this parameter for Rational ClearCase LT installations.

Member of: IClearCase interface

ProjectVOBsEmpty

Gets an empty collection of project VOBs (PVOBs)

Category

Empty collection property

VB syntax

Property ProjectVOBsEmpty As CCProjectVOBs

Visual C++ syntax

ICCProjectVOBsPtr GetProjectVOBsEmpty();

Member of: IClearCase interface

SetAbortPrompts

Causes all prompts to abort

Category

Method

VB syntax

Sub SetAbortPrompts()

Visual C++ syntax

HRESULT SetAbortPrompts();

Remarks

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

Stream

Gets a particular stream in the specified project VOB

Category

Read-only property

VB syntax

Property Stream(Selector As String) As CCStream

Visual C++ syntax

ICCStreamPtr GetStream(
     _bstr_t Selector);
Parameter
Description
Selector
An identifier of the form [stream:]stream-name[@vob-selector] to specify the stream. vob-selector is optional only when you are cd'ed to the UCM project VOB that contains the stream.

Member of: IClearCase interface

StreamsEmpty

Gets an empty collections of streams

Category

Empty collection property

VB syntax

Property StreamsEmpty As CCStreams

Visual C++ syntax

ICCStreamsPtr GetStreamsEmpty();

Member of: IClearCase interface

TriggersEmpty

Gets an empty collection of triggers

Category

Empty collection property

VB syntax

Property TriggersEmpty As CCTriggers

Visual C++ syntax

ICCTriggersPtr GetTriggersEmpty();

Member of: IClearCase interface

TriggerTypesEmpty

Gets an empty collection of trigger types

Category

Empty collection property

VB syntax

Property TriggerTypesEmpty As CCTriggerTypes

Visual C++ syntax

ICCTriggerTypesPtr GetTriggerTypesEmpty();

Member of: IClearCase interface

Version

Gets the version that is associated with the path

Category

Read-only property

VB syntax

Property Version(Path As Variant) As CCVersion

Visual C++ syntax

ICCVersionPtr GetVersion(
     const _variant_t& Path);
Parameter
Description
Path
A Variant that contains either a String containing the path to a version, or an array containing three String elements: the VOB UUID, the Version OID, and the view tag that identifies the version.

Remarks

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

VersionsEmpty

Gets an empty collection of versions

Category

Empty collection property

VB syntax

Property VersionsEmpty As CCVersions

Visual C++ syntax

ICCVersionsPtr GetVersionsEmpty();

Member of: IClearCase interface

View

Gets the specified view

Category

Read-only property

VB syntax

Property View([ Identifier As String = "" ]) As CCView

Visual C++ syntax

ICCViewPtr GetView(
     _bstr_t Identifier);
Parameter
Description
Identifier
Optional in Visual Basic. A fully qualified path in the view, or a view-tag, or a view UUID. Uses the current view if Identifier is not specified.

Member of: IClearCase interface

Views

Gets the collection of views in the specified region

Category

Read-only property

VB syntax

Property Views([ FailIfErrors As Boolean = True ], [ Region As String = "" ]) As CCViews

Visual C++ syntax

ICCViewsPtr GetViews(
     VARIANT_BOOL FailIfErrors,
     _bstr_t Region);
Parameter
Description
FailIfErrors
Optional in Visual Basic. True to fail the collection initialization if errors occur; False to continue even in the presence of errors.
Region
Optional in Visual Basic. The region from which to get the views. If not specified, gets the views from the default region. Because only one region is used in Rational ClearCase LT, you should not specify this parameter for Rational ClearCase LT installations.

Remarks

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.

ViewsEmpty

Gets an empty collection of views

Category

Empty collection property

VB syntax

Property ViewsEmpty As CCViews

Visual C++ syntax

ICCViewsPtr GetViewsEmpty();

Member of: IClearCase interface

VOB

Gets the specified VOB

Category

Read-only property

VB syntax

Property VOB(Identifier As String) As CCVOB

Visual C++ syntax

ICCVOBPtr GetVOB(
     _bstr_t Identifier);
Parameter
Description
Identifier
A path in the VOB, or a VOB-tag, or a VOB family UUID.

Member of: IClearCase interface

VOBs

Gets the collection of VOBs in the specified region

Category

Read-only property

VB syntax

Property VOBs([ FailIfErrors As Boolean = True ], [ Region As String = "" ]) As CCVOBs

Visual C++ syntax

ICCVOBsPtr GetVOBS(
     VARIANT_BOOL FailIfErrors,
     _bstr_t Region);
Parameter
Description
FailIfErrors
Optional in Visual Basic. True to fail the collection initialization if errors occur; False to continue even in the presence of errors.
Region
Optional in Visual Basic. The region from which to get the VOBs. If not specified, gets the VOBs from the default region. Because only one region is used in Rational ClearCase LT, you should not specify this parameter for Rational ClearCase LT installations.

Remarks

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.

VOBsEmpty

Gets an empty collection of VOBs

Category

Empty collection property

VB syntax

Property VOBsEmpty As CCVOBs

Visual C++ syntax

ICCVOBsPtr GetVOBsEmpty();

Member of: IClearCase interface


Feedback