ICCCheckedOutFile interface

Description

The ICCCheckedOutFile interface represents the checked-out file object.

Inheritance

ICCCheckedOutFile
inherits from ICCVersion, which inherits from ICCFile, ICCVOBObject, and IDispatch. ICCVOBObject interface ICCFile interface ICCVersion interface

Read-only properties

ByView

Gets the view to which this file is checked out

IsReserved

Gets whether or not this checkout is reserved

Methods

CheckIn

Checks in the file

Reserve

Changes the status of this checkout to reserved

UnCheckOut

Cancels the checkout for this file

UnReserve

Changes the status of this checkout to unreserved

Examples

Creation

ByView

Gets the view to which this file is checked out

Category

Read-only property

VB syntax

Property ByView As CCView

Visual C++ syntax

ICCViewPtr GetByView();

Member of: ICCCheckedOutFile interface

CheckIn

Checks in the file

Category

Method

VB syntax

Function CheckIn([ Comment As String = "" ], [ EvenIfIdentical As Boolean = False ], [ FromPath As String = "" ], [ KeepState As CCKeepState = ccKeep ]) As CCVersion

Visual C++ syntax

ICCVersionPtr CheckIn(
     _bstr_t Comment,
     VARIANT_BOOL EvenIfIdentical,
     _bstr_t FromPath,
     CCKeepState KeepState);
Parameter
Description
Comment
Optional in Visual Basic. The comment associated with the history record of the version created by the checkin operation.
EvenIfIdentical
Optional in Visual Basic. True to check in the file even if the checked-out file is identical to its predecessor version; False to fail if checked-out file is identical to its predecessor version (like cleartool checkin -identical).
FromPath
Optional in Visual Basic. Path to a file to use as the contents of the new version (like cleartool checkin -from).
KeepState
Optional in Visual Basic. Specifies one of the valid CCKeepState values (like cleartool checkin -keep or cleartool checkin -rm).

Return value

A CCVersion object that represents the newly created version.

Member of: ICCCheckedOutFile interface

IsReserved

Gets whether or not this checkout is reserved

Category

Read-only property

VB syntax

Property IsReserved As Boolean

Visual C++ syntax

VARIANT_BOOL GetIsReserved();

Member of: ICCCheckedOutFile interface

Reserve

Changes the status of this checkout to reserved

Category

Method

VB syntax

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

Visual C++ syntax

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

Member of: ICCCheckedOutFile interface

UnCheckOut

Cancels the checkout for this file

Category

Method

VB syntax

Function UnCheckOut(KeepState As CCKeepState) As CCVersion

Visual C++ syntax

ICCVersionPtr UnCheckOut(CCKeepState KeepState);
Parameter
Description
KeepState
Specifies what to do with the contents of the checked-out file using one of the valid CCKeepState values.

Return value

The version that is selected by the current view after the UnCheckOut call.

Member of: ICCCheckedOutFile interface

UnReserve

Changes the status of this checkout to unreserved

Category

Method

VB syntax

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

Visual C++ syntax

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

Member of: ICCCheckedOutFile interface


Feedback