ICCLock interface

Description

The ICCLock interface represents the Rational® ClearCase® lock object.

Users can change files and directories under Rational ClearCase source control, as well as metadata and instances using Rational ClearCase commands. In some situations, it is permanently or temporarily inadvisable to allow such changes. A mechanism is provided to lock source-controlled data, metadata, and metadata instances so that such changes are prohibited.

Inheritance

ICCLock inherits from IDispatch.

Properties and related methods

ExemptUsersStringArray and SetExemptUsersStringArray

Gets the users that are exempt from this lock

Sets the users that are exempt from this lock

IsObsolete and SetObsolete

Gets whether the locked object is marked as obsolete

Sets whether the locked object is marked as obsolete

Read-only properties

CreationRecord

Gets the creation record for this lock

LockedObject

Gets the object that is held by this lock

NumberOfExemptUsers

Gets the number of users that are exempted from this lock

VOB

Gets the VOB in which this lock resides

Methods

Remove

Removes this lock

Examples

Creation

CreationRecord

Gets the creation record for this lock

Category

Read-only property

VB syntax

Property CreationRecord As CCHistoryRecord

Visual C++ syntax

ICCHistoryRecordPtr GetCreationRecord();

Member of: ICCLock interface

ExemptUsersStringArray

Gets the users that are exempt from this lock

Category

Read-only property

VB syntax

Property ExemptUsersStringArray As Variant

Visual C++ syntax

_variant_t GetExemptUsersStringArray();

Return value

An array of Variants that contain String values which represent the names of users exempt from this lock.

IsObsolete

Gets whether the locked object is marked as obsolete

Category

Read-only property

VB syntax

Property IsObsolete As Boolean

Visual C++ syntax

VARIANT_BOOL GetIsObsolete();

See also

SetObsolete

Member of: ICCLock interface

LockedObject

Gets the object that is held by this lock

Category

Read-only property

VB syntax

Property LockedObject As CCVOBObject

Visual C++ syntax

ICCVOBObjectPtr GetLockedObject();

Member of: ICCLock interface

NumberOfExemptUsers

Gets the number of users that are exempted from this lock

Category

Read-only property

VB syntax

Property NumberOfExemptUsers As Long

Visual C++ syntax

long GetNumberOfExemptUsers();

Remove

Removes this lock

Category

Method

VB syntax

Sub Remove([ Comment As String = "" ])

Visual C++ syntax

HRESULT Remove(_bstr_t Comment);
Parameter
Description
Comment
Optional in Visual Basic. A comment to associate with the history record for this Remove operation.

Member of: ICCLock interface

SetExemptUsersStringArray

Sets the users that are exempt from this lock

Category

Method

VB syntax

Sub SetExemptUsersStringArray([ ExemptUsersStringArray As Variant ], [ Comment As String = "" ])

Visual C++ syntax

HRESULT SetExemptUsersStringArray(
     const _variant_t& ExemptUsersStringArray,
     _bstr_t Comment);
Parameter
Description
ExemptUsersStringArray
Optional in Visual Basic. Variant array of String values that contains the names of users exempted from the lock being created.
Comment
Optional in Visual Basic. A comment to associate with the history record for this SetExemptUsersStringArray operation.

SetObsolete

Sets whether the locked object is marked as obsolete

Category

Method

VB syntax

Sub SetObsolete(IsObsolete As Boolean, [ Comment As String = "" ])

Visual C++ syntax

HRESULT SetObsolete(
     VARIANT_BOOL IsObsolete,
     _bstr_t Comment);
Parameter
Description
IsObsolete
True to make the locked object obsolete in addition to locked (like cleartool lock -obsolete); False to lock the object without making it obsolete.
Comment
Optional in Visual Basic. A comment to associate with the history record for this SetObsolete operation.

See also

IsObsolete

Member of: ICCLock interface

VOB

Gets the VOB in which this lock resides

Category

Read-only property

VB syntax

Property VOB As CCVOB

Visual C++ syntax

ICCVOBPtr GetVOB();

Member of: ICCLock interface


Feedback