ICCUCMObject interface

Description

ICCUCMObject is the interface from which UCM objects inherit. For historical reasons, ICCActivity inherits from ICCVOBObject instead.

Inheritance

ICCUCMObject inherits
from ICCVOBObject, which inherits from IDispatch. The descendants of ICCUCMObject
are ICCBaseline, ICCComponent, ICCFolder, ICCProject, and ICCStream. ICCVOBObject interface ICCBaseline interface ICCComponent interface ICCFolder interface ICCProject interface ICCStream interface

Properties and related methods

Group and SetGroup

Gets the group to which the UCM object belongs

Sets the group to which the UCM object belongs

Master and SetMaster

Gets the master replica for this UCM object

Sets the master replica for this UCM object

Owner and SetOwner

Gets the owner of this UCM object

Sets the owner of this UCM object

Read-only properties

Lock

Gets the lock on this UCM object

Name (default property)

Gets the name of this UCM object

ProjectVOB

Gets the project VOB that contains this UCM object

Title

Gets the title of this UCM object

Methods

CreateLock

Locks this UCM object

Examples

Creation

This interface is used only through inheritance.

CreateLock

Locks this UCM object

Category

Method

VB syntax

Sub CreateLock([ Comment As String = "" ], [ Obsolete As Boolean = False ], [ ExemptUsersStringArray As Variant ])

Visual C++ syntax

HRESULT CreateLock(
     _bstr_t Comment,
     VARIANT_BOOL Obsolete,
     const _variant_t& ExemptUsersStringArray = vtMissing);
Parameter
Description
Comment
Optional in Visual Basic. A comment to associate with the history record for this CreateLock operation.
Obsolete
Optional in Visual Basic. True to make the locked UCM object obsolete in addition to locked (like cleartool lock -obsolete); False to lock the UCM object without making it obsolete.
ExemptUsersStringArray
Optional. A Variant array of String values that contains the names of users exempted from the lock being created.

Member of: ICCUCMObject interface

Group

Gets the group to which the UCM object belongs

Category

Read-only property

VB syntax

Property Group As String

Visual C++ syntax

_bstr_t GetGroup();

See also

SetGroup

Member of: ICCUCMObject interface

Lock

Gets the lock on this UCM object

Category

Read-only property

VB syntax

Property Lock As CCLock

Visual C++ syntax

ICCLockPtr GetLock();

Member of: ICCUCMObject interface

Master

Gets the master replica for this UCM object

Category

Read-only property

VB syntax

Property Master As String

Visual C++ syntax

_bstr_t GetMaster();

See also

SetMaster

Member of: ICCUCMObject interface

Name

Gets the name of this UCM object

Category

Read-only property

VB syntax

Property Name As String

Visual C++ syntax

_bstr_t GetName();

Member of: ICCUCMObject interface

Owner

Gets the owner of this UCM object

Category

Read-only property

VB syntax

Property Owner As String

Visual C++ syntax

_bstr_t GetOwner();

See also

SetOwner

Member of: ICCUCMObject interface

ProjectVOB

Gets the project VOB that contains this UCM object

Category

Read-only property

VB syntax

Property ProjectVOB As CCProjectVOB

Visual C++ syntax

ICCProjectVOBPtr GetProjectVOB();

Member of: ICCUCMObject interface

SetGroup

Sets the group to which the UCM object belongs

Category

Method

VB syntax

Sub SetGroup(NewGroup As String, [ Comment As String = "" ])

Visual C++ syntax

HRESULT SetGroup(
     _bstr_t NewGroup,
     _bstr_t Comment);
Parameter
Description
NewGroup
Name of the new group to which the UCM object will belong.
Comment
Optional in Visual Basic. A comment to associate with the history record for this SetGroup operation.

See also

Group

Member of: ICCUCMObject interface

SetMaster

Sets the master replica for this UCM object

Category

Method

VB syntax

Sub SetMaster(Replica As String, [ Comment As String = "" ])

Visual C++ syntax

HRESULT SetMaster(
     _bstr_t Replica,
     _bstr_t Comment);
Parameter
Description
Replica
Name of the replica to which mastership of the VOB's replica is being transferred.
Comment
Optional in Visual Basic. A comment to associate with the history record for this SetMaster operation.

See also

Master

Member of: ICCUCMObject interface

SetOwner

Sets the owner of this UCM object

Category

Method

VB syntax

Sub SetOwner(NewOwner As String, [ Comment As String = "" ])

Visual C++ syntax

HRESULT SetOwner(
     _bstr_t NewOwner,
     _bstr_t Comment);
Parameter
Description
NewOwner
Name of the new owner of this UCM object
Comment
Optional in Visual Basic. A comment to associate with the history record for this SetOwner operation.

See also

Owner

Member of: ICCUCMObject interface

Title

Gets the title of this UCM object

Category

Read-only property

VB syntax

Property Title As String

Visual C++ syntax

_bstr_t GetTitle();

Remarks

Only CCProject, CCFolder, CCBaseline and CCStream objects are defined as having a Title. Title fails if you attempt to invoke it on a CCComponent object

Member of: ICCUCMObject interface


Feedback