Hide Table of Contents
GetReferenceTree Method (IEdmFile5)

Gets an interface to the files that reference or are referenced by this file.

Syntax

Visual Basic (Declaration) 
Function GetReferenceTree( _
   ByVal lParentFolderID As System.Integer, _
   Optional ByVal lVersionNo As System.Integer _
) As IEdmReference5
C# 
IEdmReference5 GetReferenceTree( 
   System.int lParentFolderID,
   System.int lVersionNo
)
C++/CLI 
IEdmReference5^ GetReferenceTree( 
&   System.int lParentFolderID,
&   System.int lVersionNo
) 

Parameters

lParentFolderID
ID of the file's parent folder (see Remarks)
lVersionNo
Version of the file for which to get references; 0 to get the latest version

Return Value

IEdmReference5

Example

Remarks

Some file types, such as files from AutoCAD, SOLIDWORKS, MS Word, etc., contain references to other files. You can also set up your own references via SOLIDWORKS Enterprise PDM's User Defined File References dialog box. SOLIDWORKS Enterprise PDM manages all of these references for you, and they appear in the check-in dialog box in the form of a reference tree.

To specify lParentFolderID, inspect all of the parent folders of this file by calling IEdmFile5::GetFirstFolderPosition and IEdmFile5::GetNextFolder.

Use IEdmReference5 that is returned in ppoRetRoot to enumerate referenced files and referencing files and set up user-defined references.

C++ programmers not using smart-pointer wrapper functions must release the returned interface, IEdmReference5.

Return codes:

  • S_OK: The method successfully executed.
  • S_FALSE: An argument is invalid.
 

See Also

Availability

SOLIDWORKS Enterprise PDM Version 5.2


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   GetReferenceTree Method (IEdmFile5)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:



x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2015 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.