ICCFile interface

Description

Every element, version, and a special class of versions, the checked-out file, share common properties represented in CAL by the ICCFile interface.

Note that CAL uses the term File as a shorthand for VOB File System Object. The interface applies to directory objects and file objects.

Inheritance

ICCFile inherits from
ICCVOBObject, which inherits from ICDispatch. Both ICCElement and ICCVersion
are descendants of ICCFile. ICCCheckedOutFile inherits from ICCVersion. ICCVOBObject interface ICCElement interface ICCVersion interface ICCCheckedOutFile interface

Read-only properties

ExtendedPath

Gets the VOB-extended path of this file system object

ExtendedPathInView

Gets the VOB-extended path of this file system object in the given view

IsDirectory

Gets whether or not this file system object is a directory

Path (default property)

Gets the path to this file system object

PathInView

Gets the path to this file system object in the given view

View

Gets the view used to resolve this file system object

VOB

Gets the VOB containing this file system object

Examples

Creation

This interface is used only through inheritance.

ExtendedPath

Gets the VOB-extended path of this file system object

Category

Read-only property

VB syntax

Property ExtendedPath As String

Visual C++ syntax

_bstr_t GetExtended Path();

Remarks

You may need to use ExtendedPathInView to specify a view for path resolution.

Member of: ICCFile interface

ExtendedPathInView

Gets the VOB-extended path of this file system object in the given view

Category

Read-only property

VB syntax

Property ExtendedPathInView (pView As CCView) As String

Visual C++ syntax

_bstr_t GetExtendedPathInView(ICCView* pView);
Parameter
Description
pView
The view to use for resolving the path. Passing a null pView (Nothing in Visual Basic or 0 in C++) is equivalent to invoking ExtendedPath.

Remarks

If you do not need to specify a view for path resolution, you can use ExtendedPath.

Member of: ICCFile interface

IsDirectory

Gets whether or not this file system object is a directory

Category

Read-only property

VB syntax

Property IsDirectory As Boolean

Visual C++ syntax

VARIANT_BOOL GetIsDirectory();

Member of: ICCFile interface

Path

Gets the path to this file system object

Category

Read-only property

VB syntax

Property Path As String

Visual C++ syntax

_bstr_t GetPath();

Remarks

You may need to use PathInView to specify a view for path resolution.

Member of: ICCFile interface

PathInView

Gets the path to this file system object in the given view

Category

Read-only property

VB syntax

Property PathInView (pView As CCView) As String

Visual C++ syntax

_bstr_t GetPathInView(ICCView* pView);
Parameter
Description
pView
The view to use for resolving the path. Passing a null pView(Nothing in Visual Basic or 0 in C++) is equivalent to invoking Path.

Remarks

If you do not need to specify a view for path resolution, you can use Path.

Member of: ICCFile interface

View

Gets the view used to resolve this file system object

Category

Read-only property

VB syntax

Property View As CCView

Visual C++ syntax

ICCViewPtr GetView();

Member of: ICCFile interface

VOB

Gets the VOB containing this file system object

Category

Read-only property

VB syntax

Property VOB As CCVOB

Visual C++ syntax

ICCVOBPtr GetVOB();

Member of: ICCFile interface


Feedback