ICCVOBObject interface
Description
Many of the objects that are kept under source control and metadata about the source-control database have common properties. The ICCVOBObject interface is an ancestor interface for those objects.
All objects inheriting from ICCVOBObject can have attributes and can have hyperlinks attached to them.
Inheritance

Read-write properties
- Comment
Gets and sets the comment associated with the VOB object
Read-only properties
- Attribute
Gets an attribute of the specified type on this VOB object
- Attributes
Gets the collection of attributes associated with this VOB object
- CreationRecord
Gets the creation record for the VOB object
- HistoryRecords
Gets the collection of history records for this object
- Hyperlinks
Gets the collection of hyperlinks associated with this VOB object
- OID
Gets the object identifier for the VOB object
- VOBFamilyUUID
Gets the VOB family UUID for the VOB of this VOB object
Examples
Creation
This interface is used only through inheritance.
Attribute
Gets an attribute of the specified type on this VOB object
Category
Read-only property
VB syntax
Property Attribute(AttributeType As String) As CCAttribute
Visual C++ syntax
ICCAttributePtr GetAttribute(_bstr_t AttributeType);
- Parameter
- Description
- AttributeType
- Name of the attribute type.
Member of: ICCVOBObject interface
Attributes
Gets the collection of attributes associated with this VOB object
Category
Read-only property
VB syntax
Property Attributes As CCAttributes
Comment
Gets and sets the comment associated with the VOB object
Category
Read-write property
VB syntax
Property Comment As String
Visual C++ syntax
_bstr_t GetComment(); void PutComment(_bstr_t NewComment);
- Parameter
- Description
- NewComment
- Visual C++ only. A comment string to associate with the VOB object.
Member of: ICCVOBObject interface
CreationRecord
Gets the creation record for the VOB object
Category
Read-only property
VB syntax
Property CreationRecord As CCHistoryRecord
HistoryRecords
Gets the collection of history records for this object
Category
Read-only property
VB syntax
Property HistoryRecords(pICCBranchType As CCBranchType, [ Since As Date = 0 ], [ User As String = "" ], [ Minor As Boolean = False ], [ ExcludeCheckOutEvents As Boolean = False ], [ Recurse As Boolean = False ], [ DirectoryOnly As Boolean = False ]) As CCHistoryRecords
Visual C++ syntax
ICCHistoryRecordsPtr GetHistoryRecords( ICCBranchType* pICCBranchType, DATE Since, _bstr_t User, VARIANT_BOOL Minor, VARIANT_BOOLExcludeCheckOutEvents, VARIANT_BOOL Recurse, VARIANT_BOOL DirectoryOnly);
- Parameter
- Description
- pICCBranchType
- Limit the collection of history records on an element to those versions on a branch of the specified branch type. Specify Nothing (VB) or 0 (C++) to get all the history records on an element (like cleartool lshistory -branch).
- Since
- Optional in Visual Basic. Limit the collection to events recorded since (at or after) the specified date (like cleartool lshistory -since).
- User
- Optional in Visual Basic. Limit the collection to events for commands entered by the specified user (like cleartool lshistory -user).
- Minor
- Optional in Visual Basic. True to include in the collection less important events (like cleartool lshistory -minor); False to exclude minor events.
- ExcludeCheckOutEvents
- Optional in Visual Basic. True to exclude checkout version events (like cleartool lshistory -nco); False to include such events.
- Recurse
- Optional in Visual Basic. True to process the entire subtree below any directory element encountered (like cleartool lshistory -recurse); False to process only the directory element itself, or a file.
- DirectoryOnly
- Optional in Visual Basic. True to limit the collection to events on a directory itself (like cleartool lshistory -directory); False to limit the collection to events on a directory's contents.
Remarks
The lshistory reference page provides a description of options corresponding to the CAL filtering options.
Member of: ICCVOBObject interface
Hyperlinks
Gets the collection of hyperlinks associated with this VOB object
Category
Read-only property
VB syntax
Property Hyperlinks([ HyperlinkType As String = "" ]) As CCHyperlinks
Visual C++ syntax
ICCHyperlinksPtr GetHyperlinks(_bstr_t HyperlinkType);
- Parameter
- Description
- HyperlinkType
- Optional in Visual Basic. Limit the collection to hyperlinks of this particular type associated with this VOB object.
Member of: ICCVOBObject interface
OID
Gets the object identifier for the VOB object
Category
Read-only property
VB syntax
Property OID As String
VOBFamilyUUID
Gets the VOB family UUID for the VOB of this VOB object
Category
Read-only property
VB syntax
Property VOBFamilyUUID As String