ICCCheckedOutFileQuery interface

Description

There are a variety of Rational® ClearCase® parameters that specify which checked-out versions to find in a particular query. The ICCCheckedOutFileQuery interface provides client code with a mechanism to set one or more of these parameters, and to use the Apply method to return a collection of handles to ICCCheckedOutFile interfaces.

Inheritance

ICCCheckedOutFileQuery inherits from IDispatch.

Read-write properties

BranchType

Restricts the collection to checked-out files on branches of the specified type

ExamineAllReplicas

Includes in the collection checkouts in all replicas of the VOB that contains the specified paths (like cleartool lscheckout -areplicas)

PathArray

Includes in the collection the specified paths, subject to interpretation as specified by PathSelects

PathSelects

Specifies which checked-out files are selected by the path in a checked-out file query

UseCurrentView

Restricts the collection to files checked out in the current view

User

Restricts the collection to files checked out by the specified user

Methods

Apply

Applies the checked-out file query after its properties are set

Examples

Creation

You can get a CCCheckedOutFileQuery object from the following interface:

Apply

Applies the checked-out file query after its properties are set

Category

Method

VB syntax

Function Apply As CCCheckedOutFiles

Visual C++ syntax

ICCCheckedOutFilesPtr Apply();

Return value

The collection of checked-out files returned for the query.

Remarks

A view context is required for Apply to succeed.

Member of: ICCCheckedOutFileQuery interface

BranchType

Restricts the collection to checked-out files on branches of the specified type

Category

Read-write property

VB syntax

Property BranchType As String

Visual C++ syntax

_bstr_t GetBranchType();
void PutBranchType(_bstr_t NewBranchType);
Parameter
Description
NewBranchType
Visual C++ only. The branch type to which the collection of checked-out files will be limited.

Member of: ICCCheckedOutFileQuery interface

ExamineAllReplicas

Includes in the collection checkouts in all replicas of the VOB that contains the specified paths (like cleartool lscheckout -areplicas)

Category

Read-write property

VB syntax

Property ExamineAllReplicas As Boolean

Visual C++ syntax

VARIANT_BOOL GetExamineAllReplicas();
void PutExamineAllReplicas(VARIANT_BOOL NewExamineAllReplicas);
Parameter
Description
NewExamineAllReplicas
Visual C++ only. True to include checkouts in all replicas of the VOB containing the specified paths; False to include only the VOB containing the specified paths.

Member of: ICCCheckedOutFileQuery interface

PathArray

Specifies which checked-out files are selected by the path in a checked-out file query

Category

Read-write property

VB syntax

Property PathArray As Variant

Visual C++ syntax

_variant_t GetPathArray();
void PutPathArray(const _variant_t& NewPathArray);
Parameter
Description
NewPathArray
Visual C++ only. A Variant array of string values that specify the paths to include in the collection.

Remarks

A Variant array of String values that contain the paths.

PathSelects

Specifies which checked-out files are selected by the path in a checked-out file query

Category

Read-write property

VB syntax

Property PathSelects As CCPath_Selection

Visual C++ syntax

CCPath_Selection GetPathSelects();
void PutPathSelects(CCPath_Selection NewSelection);
Parameter
Description
NewSelection
Visual C++ only. Specify how to interpret the path for the selection of checked-out files using one of the valid CCPath_Selection values.

Remarks

CCPath_Selection values specify how to interpret the path.

UseCurrentView

Restricts the collection to files checked out in the current view

Category

Read-write property

VB syntax

Property UseCurrentView As Boolean

Visual C++ syntax

VARIANT_BOOL GetUseCurrentView();
void PutUseCurrentView(VARIANT_BOOL NewUseCurrentView);
Parameter
Description
NewUseCurrentView
Visual C++ only. True to restrict the collection to files checked out in the current view; False to consider all views.

Member of: ICCCheckedOutFileQuery interface

User

Restricts the collection to files checked out by the specified user

Category

Read-write property

VB syntax

Property User As String

Visual C++ syntax

_bstr_t GetUser();
void PutUser(_bstr_t NewUser);
Parameter
Description
NewUser
Visual C++ only. The name of the user for whom checked-out files will be included in the collection.

Member of: ICCCheckedOutFileQuery interface


Feedback