ICCView interface

Description

The ICCView interface represents the Rational® ClearCase® view object.

Inheritance

ICCView inherits from IDispatch and has no descendants.

Properties and related methods

CurrentActivity and SetActivity

Gets the current activity of this view

Sets the current activity of this view

Read-write properties

BuildsNonShareableDOs

Gets and sets whether this dynamic view builds non-shareable derived objects (DOs)

ConfigSpec

Gets and sets the config spec of this view

IsActive

Gets and sets whether the dynamic view is active on the local machine

Read-only properties

DisplayableConfigSpec

Gets a displayable form of the config spec for this view

Host

Gets the host on which the storage area for this view resides

IsSnapShot

Gets whether this view is a snapshot view

IsUCMView

Gets whether this view is a UCM view

Stream

Gets the stream to which this view is attached

TagName (default property)

Gets the view-tag name

Examples

Creation

BuildsNonShareableDOs

Gets and sets whether this dynamic view builds non-shareable derived objects (DOs)

Category

Read-write property

VB syntax

Property BuildsNonShareableDOs As Boolean

Visual C++ syntax

VARIANT_BOOL GetBuildsNonShareableDOs();
void PutBuildsNonShareableDOs(VARIANT_BOOL NewBuildsNonShareableDOs);
Parameter
Description
NewBuildsNonShareableDOs
Visual C++ only. True for the view to build non-shareable derived objects; False for the view to build shareable derived objects.

Remarks

Setting this property applies only to dynamic views.

Member of: ICCView interface

CurrentActivity

Gets the current activity of this view

Category

Read-only property

VB syntax

Property CurrentActivity As CCActivity

Visual C++ syntax

ICCActivityPtr GetCurrentActivity();

See also

SetActivity

Member of: ICCView interface

ConfigSpec

Gets and sets the config spec of this view

Category

Read-write property

VB syntax

Property ConfigSpec As String

Visual C++ syntax

_bstr_t GetConfigSpec();
void PutConfigSpec(_bstr_t NewConfigSpec);
Parameter
Description
NewConfigSpec
Visual C++ only. The string that contains the config spec rules for the view.

Remarks

ConfigSpec returns the config spec with the line terminators that it has stored within it. Config specs generated on machines that run Linux or the UNIX system may not have <CR> characters in them. If you require the <CR> characters for display, use DisplayableConfigSpec. For more information about config spec syntax, see the config_spec reference page.

DisplayableConfigSpec

Gets a displayable form of the config spec for this view

Category

Read-only property

VB syntax

Property DisplayableConfigSpec As String

Visual C++ syntax

_bstr_t GetDisplayableConfigSpec();

Remarks

ConfigSpec returns the config spec with the line terminators that it has stored within it. Config specs generated on machines that run Linux or the UNIX system may not have <CR> characters in them. If you require the <CR> characters for display, use DisplayableConfigSpec.

See also

ConfigSpec

Member of: ICCView interface

Host

Gets the host on which the storage area for this view resides

Category

Read-only property

VB syntax

Property Host As String

Visual C++ syntax

_bstr_t GetHost();

Member of: ICCView interface

IsActive

Gets and sets whether the dynamic view is active on the local machine

Category

Read-write property

VB syntax

Property IsActive As Boolean

Visual C++ syntax

VARIANT_BOOLGetIsActive();
     void PutIsActive(VARIANT_BOOL NewIsActive);
Parameter
Description
NewIsAcitve
Visual C++ only. True to make the view active on the local machine; False to not make the view active on the local machine.

Remarks

Setting this property applies only to dynamic views.

Member of: ICCView interface

IsSnapShot

Gets whether this view is a snapshot view

Category

Read-only property

VB syntax

Property IsSnapShot As Boolean

Visual C++ syntax

VARIANT_BOOL GetIsSnapshot();

Member of: ICCView interface

IsUCMView

Gets whether this view is a UCM view

Category

Read-only property

VB syntax

Property IsUCMView As Boolean

Visual C++ syntax

VARIANT_BOOL GetIsUCMView();

Member of: ICCView interface

SetActivity

Sets the current activity of this view

Category

Method

VB syntax

Sub SetActivity(NewActivity As CCActivity, [ Comment As String = "" ])

Visual C++ syntax

HRESULT SetActivity,
     ICCActivity* NewActivity,
     _bstr_t Comment);
Parameter
Description
NewActivity
Identifies the activity to be set. Passing Nothing (Visual Basic) or 0 (Visual C++) will unset the activity. In a CRM-enabled project, the passed-in object must already be bound to a Rational ClearQuest® record.
Comment
Optional in Visual Basic. A comment to associate with the history record for this SetActivity operation.

Remarks

It is an error to attempt to set a non-Rational ClearQuest activity in a view associated with a CRM-enabled project. For CRM-enabled activities, if a Rational ClearQuest login session has not already been established when SetActivity is called, a prompt for a login is displayed.

Stream

Gets the stream to which this view is attached

Category

Read-only property

VB syntax

Property Stream As CCStream

Visual C++ syntax

ICCStreamPtr GetStream();

Member of: ICCView interface

TagName

Gets the view-tag name

Category

Read-only property

VB syntax

Property TagName As String

Visual C++ syntax

_bstr_t GetTagName();

Member of: ICCView interface


Feedback