ICCTrigger interface

Description

The ICCTrigger interface represents the Rational® ClearCase® trigger object.

Whenever data that is kept under source control or metadata that is associated with source-controlled data is changed, that change is represented as an event. Users are allowed to monitor these events or prohibit the event from occurring. Based on the event type, a user pre-operation (pre-op) trigger or a post-operation (post-op) trigger can be fired.

Inheritance

ICCTrigger inherits from IDispatch.

Read-only properties

IsOnAttachedList

Gets whether this trigger is on the attached list of its element

IsOnInheritanceList

Gets whether this trigger is on the inheritance list of an element, if element is a directory element

Type

Gets the trigger type of this element trigger

VOB

Gets the VOB that contains this element trigger

Methods

Remove

Removes this trigger from the elements to which it is attached

Examples

Creation

You can get a CCTrigger object from the following interfaces:

IsOnAttachedList

Gets whether this trigger is on the attached list of its element

Category

Read-only property

VB syntax

Property IsOnAttachedList As Boolean

Visual C++ syntax

VARIANT_BOOL GetIsOnAttachedList();

Member of: ICCTrigger interface

IsOnInheritanceList

Gets whether this trigger is on the inheritance list of an element, if element is a directory element

Category

Read-only property

VB syntax

Property IsOnInheritanceList As Boolean

Visual C++ syntax

VARIANT_BOOL GetIsOnInheritanceList();

Member of: ICCTrigger interface

Remove

Removes this trigger from the elements to which it is attached

Category

Method

VB syntax

Sub Remove([ Comment As String = "" ], [ Recurse As Boolean = False ], [ DirectoryListsSubset As Variant ])

Visual C++ syntax

HRESULT Remove(
     _bstr_t Comment,
     VARIANT_BOOL Recurse,
     const _variant_t& DirectoryListsSubset = vtMissing);
Parameter
Description
Comment
Optional in Visual Basic. A comment to associate with the history record for this Remove operation.
Recurse
Optional in Visual Basic. True to process the entire subtree below any directory element encountered; False to process only the directory element itself, or a file.
DirectoryListsSubset
Optional. If the trigger is attached to a directory, DirectoryListsSubset controls the trigger's inclusion on the attached and inheritance lists. Must be a Variant containing one of the valid CCTriggerDirectorySubset values.

Member of: ICCTrigger interface

Type

Gets the trigger type of this element trigger

Category

Read-only property

VB syntax

Property Type As CCTriggerType

Visual C++ syntax

ICCTriggerTypePtr GetType();

Member of: ICCTrigger interface

VOB

Gets the VOB that contains this element trigger

Category

Read-only property

VB syntax

Property VOB As CCVOB

Visual C++ syntax

ICCVOBPtr GetVOB();

Member of: ICCTrigger interface


Feedback