Initial Commit of the PDM project (ready for DWS migration)

This commit is contained in:
will
2026-04-20 08:42:38 -05:00
commit dda7b664e7
2721 changed files with 442772 additions and 0 deletions

View File

@@ -0,0 +1,169 @@
<html xmlns:mshelp="http://msdn.microsoft.com/mshelp">
<head>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
<meta content="history" name="save">
<meta content="Innovasys Document! X (http://www.innovasys.com)" name="GENERATOR">
<title>GetReferenceTree Method (IEdmFile5)</title>
<link href="stylesheets/dotnet2005.css" type="text/css" rel="stylesheet">
<script src="script/dotnet2005.js" type="text/javascript">
</script><xml>
<MSHelp:Keyword Index="F" Term="EPDM.Interop.epdm.IEdmFile5.GetReferenceTree" />
<MSHelp:Attr Name="DevLang" Value="CSharp" />
<MSHelp:Attr Name="DevLang" Value="VB" />
<MSHelp:Attr Name="DevLang" Value="JScript" />
<MSHelp:Attr Name="TopicType" Value="kbSyntax"/>
<MSHelp:Attr Name="LinkGroup" Value="Help"/>
<MSHelp:Attr Name="Locale" Value="kbEnglish"/>
<MSHelp:Attr Name="HelpPriority" Value="1"/>
</xml>
<script src="script/hs-expandcollapse.js" type="text/javascript"></script>
<script src="script/hs-enlargeimage.js" type="text/javascript"></script>
<script src="script/swfobject.js" type="text/javascript"></script>
<script src="script/hs-common.js" type="text/javascript"></script>
<script src="script/hs-heading-expandcollapse.js" type="text/javascript"></script>
<script src="script/hs-tabstrip.js" type="text/javascript"></script>
</head>
<body id="dxBody" topmargin="0">
<form>
<input class="userDataStyle" id="userDataCache" type="hidden" name="userDataCache"> <input id="hiddenScrollOffset" type="hidden" name=
"hiddenScrollOffset"> <img id="collapseImage" style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src="dotnetimages/collapse.gif"> <img id="expandImage"
style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src="dotnetimages/expand.gif"> <img id="collapseAllImage" style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px"
src="dotnetimages/collapse.gif"> <img id="expandAllImage" style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src="dotnetimages/expand.gif"> <img id=
"dropDownImage" style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src="dotnetimages/drpdown.gif"> <img id="dropDownHoverImage" style=
"DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src="dotnetimages/drpdown_orange.gif"> <img id="copyImage" style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src=
"dotnetimages/copycode.gif"> <img id="copyHoverImage" style="DISPLAY: none; WIDTH: 0px; HEIGHT: 0px" src="dotnetimages/copycodeHighlight.gif">
</form>
<div id="pagetop">
<table id="pagetoptable1" width="100%">
<tbody>
<tr id="pagetoptable1row1">
<td align="left"><span id="projecttitle">SOLIDWORKS PDM Professional API Help</span></td>
<td align="right"><span id="feedbacklink"><a href="mailto:apihelp.feedback@3ds.com?subject=Documentation Feedback: EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFile5~GetReferenceTree.html">Send Feedback</a></span></td>
</tr>
<tr id="pagetoptable1row2">
<td align="left" colspan="2"><span id="pagetitle">GetReferenceTree Method (IEdmFile5)</span></td>
</tr>
<tr id="pagetoptable1row3">
<td colspan="2"><a onclick="javascript:openSectionById('seeAlsoSectionHeader');" href="#seealsobookmark">
See Also</a>&nbsp;
<a href="#ExampleBookmark" onclick="javascript:openSectionById('exampleSectionHeader');">Example</a></td>
</tr>
</tbody>
</table>
<table id="pagetoptable2" cellspacing="0" cellpadding="0" width="100%">
<tbody>
<tr>
<td><span id="toggleExpandedAll"><img class="toggleAll" id="toggleExpandedAllImage" src="dotnetimages/collapse.gif"> <label id=
"collapseAllLabel" style="DISPLAY: none" for="toggleExpandedAllImage">Collapse All</label> <label id="expandAllLabel" style="DISPLAY: none" for="toggleExpandedAllImage">
Expand All</label></span> <span id="languageFilterToolTip"
onmouseover='document.getElementById("languageFilterImage").src=document.getElementById("dropDownHoverImage").src;' style="CURSOR: default"
onfocusout='document.getElementById("languageFilterImage").src=document.getElementById("dropDownImage").src;' onclick=
"showBox('dxlanguagemenu',event,document.getElementById('languageFilterImage'))" onfocusin=
'document.getElementById("languageFilterImage").src=document.getElementById("dropDownHoverImage").src;' onmouseout=
'document.getElementById("languageFilterImage").src=document.getElementById("dropDownImage").src;'><img id="languageFilterImage" src=
"dotnetimages/drpdown.gif"> <label id="showAllLabel" style="DISPLAY: none" for="languageFilterImage">
Language Filter: All</label> <label id="multipleLabel" style=
"DISPLAY: none" for="languageFilterImage">Language Filter: Multiple</label>
<label id="VBLabel" for="languageFilterImage" style="display: none;">Language Filter: Visual Basic</label>
<label id="CSLabel" for="languageFilterImage" style="display: none;">Language Filter: C#</label>
<label id="CPP2005Label" for="languageFilterImage" style="display: none;">Language Filter: C++/CLI</label>
</span></td>
</tr>
</tbody>
</table><table width="100%" id="pagetopbreadcrumbs" cellspacing="0" cellpadding="0"><tr><td>
<a href="EPDM.Interop.epdm~EPDM.Interop.epdm_namespace.html">EPDM.Interop.epdm Namespace</a>
> <a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFile5.html">IEdmFile5 Interface</a>
: GetReferenceTree Method (IEdmFile5)</td></tr></table>
<div class="dxpopupbubble" id="dxlanguagemenu">
<input id="VBCheckbox" type="checkbox" name="languageFilter" onClick="setLanguage(this)" />
<label class="languageFilter" for="VBCheckbox">
Visual Basic
</label>
<br /><input id="CSCheckbox" type="checkbox" name="languageFilter" onClick="setLanguage(this)" />
<label class="languageFilter" for="CSCheckbox">
C#
</label>
<br /><input id="CPP2005Checkbox" type="checkbox" name="languageFilter" onClick="setLanguage(this)" />
<label class="languageFilter" for="CPP2005Checkbox">
C++/CLI
</label>
</div>
<div id="lParentFolderID_box" class="dxpopupbubble">
<DL><DT class="popupbubble"><I>lParentFolderID</I></DT>
<DD class="popupbubble">ID of the file's parent folder (see <STRONG>Remarks</STRONG>)</DD></DL>
</div>
<div id="lVersionNo_box" class="dxpopupbubble">
<DL><DT class="popupbubble"><I>lVersionNo</I></DT>
<DD class="popupbubble">Version of the file for which to get references; 0 to get the latest version</DD></DL>
</div>
</div>
<div id="pagebody" valign="bottom">
<a name="topBookmark"></a>
<div id="mainbody">
<div class="saveHistory" id="allHistory" onsave="saveAll()" onload="loadAll()"></div>
Gets an interface to the files that reference or are referenced by this file.
<h1 class="heading"><span class="expandcollapse" tabindex="0"><img id="syntaxToggle" class="toggle" name="toggleSwitch" src="dotnetimages/collapse.gif"></img>Syntax</span></h1><div id="syntaxSection" class="section" name="collapseableSection"><DIV class=LanguageSpecific id=Syntax_VB><table class="syntaxtable" width="100%" cellpadding="0" cellspacing="0"><tr><th>Visual Basic</th><th>&nbsp;</th></tr><tr><td colspan="2"><pre>Function GetReferenceTree( _
&nbsp;&nbsp;&nbsp;ByVal <i><a class="parameter" id="lParentFolderID" href="#" onclick="javascript:showParamBox(event);">lParentFolderID</a></i> As System.Integer, _
&nbsp;&nbsp;&nbsp;Optional ByVal <i><a class="parameter" id="lVersionNo" href="#" onclick="javascript:showParamBox(event);">lVersionNo</a></i> As System.Integer _
) As <a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmReference5.html">IEdmReference5</a></pre></tr></table></div>
<DIV class=LanguageSpecific id=Syntax_CS><table class="syntaxtable" width="100%" cellpadding="0" cellspacing="0"><tr><th>C#</th><th>&nbsp;</th></tr><tr><td colspan="2"><pre><a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmReference5.html">IEdmReference5</a> GetReferenceTree(
&nbsp;&nbsp;&nbsp;System.int <i><a class="parameter" id="lParentFolderID" href="#" onclick="javascript:showParamBox(event);">lParentFolderID</a></i>,
&nbsp;&nbsp;&nbsp;System.int <i><a class="parameter" id="lVersionNo" href="#" onclick="javascript:showParamBox(event);">lVersionNo</a></i>
)</pre></tr></table></div>
<DIV class=LanguageSpecific id=Syntax_CPP2005><table class="syntaxtable" width="100%" cellpadding="0" cellspacing="0"><tr><th>C++/CLI</th><th>&nbsp;</th></tr><tr><td colspan="2"><pre><a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmReference5.html">IEdmReference5^</a> GetReferenceTree(
&&nbsp;&nbsp;&nbsp;System.int <i><a class="parameter" id="lParentFolderID" href="#" onclick="javascript:showParamBox(event);">lParentFolderID</a></i>,
&&nbsp;&nbsp;&nbsp;System.int <i><a class="parameter" id="lVersionNo" href="#" onclick="javascript:showParamBox(event);">lVersionNo</a></i>
) </pre></tr></table></div>
<h4 class=dxh4>Parameters</h4><DL><DT><I>lParentFolderID</I></DT>
<DD>ID of the file's parent folder (see <STRONG>Remarks</STRONG>)</DD><DT><I>lVersionNo</I></DT>
<DD>Version of the file for which to get references; 0 to get the latest version</DD></DL>
<h4 class=dxh4>Return Value</h4><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmReference5.html">IEdmReference5</A></div>
<a name="exampleBookmark"></a>
<h1 class="heading"><span class="expandcollapse" tabindex="0"><img id="exampleToggle" class="toggle" name="toggleSwitch" src="dotnetimages/collapse.gif"></img>Example</span></h1><div id="exampleSection" class="section" name="collapseableSection"><a href="Get_File_References_for_File_Example_CSharp.htm">Get File References for a File (C#)</a>
<br/><a href="Get_File_References_for_File_Example_VBNET.htm">Get File References for a File (VB.NET)</a>
</div>
<h1 class="heading"><span class="expandcollapse" tabindex="0"><img id="remarksToggle" class="toggle" name="toggleSwitch" src="dotnetimages/collapse.gif"></img>Remarks</span></h1><div id="remarksSection" class="section" name="collapseableSection"><P>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 PDM Professional's User Defined File References dialog box. SOLIDWORKS PDM Professional manages all of these references for you, and they&nbsp;appear in the check-in dialog box in the form of a reference tree.</P>
<P>To specify lParentFolderID, inspect all of the parent folders of this file by&nbsp;calling <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFile5~GetFirstFolderPosition.html">IEdmFile5::GetFirstFolderPosition</A> and <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFile5~GetNextFolder.html">IEdmFile5::GetNextFolder</A>.</P>
<P>Use IEdmReference5 that is returned in ppoRetRoot to enumerate referenced files and referencing files and set up user-defined references.</P>
<P>C++ programmers not using smart-pointer wrapper functions must release the returned interface, IEdmReference5.</P>
<P>See <A href="ReturnCodes.htm">Return Codes</A>&nbsp;for the complete list of potential success and error codes. The following are&nbsp;just a few examples:</P>
<UL>
<LI>S_OK: The method successfully executed.
<LI>S_FALSE: An argument is invalid.</LI></UL></div>&nbsp;
<a name="seealsobookmark"></a>
<h1 class="heading"><span class="expandcollapse" tabindex="0"><img id="seealsoToggle" class="toggle" name="toggleSwitch" src="dotnetimages/collapse.gif"></img>See Also</span></h1><div id="seealsoSection" class="section" name="collapseableSection"><h4 class="dxh4"></h4><a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFile5.html">IEdmFile5 Interface</a>
<br/><a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFile5_members.html">IEdmFile5 Members</a>
</p>
</div>
<h1 class="heading"><span class="expandcollapse" tabindex="0"><img id="availabilityToggle" class="toggle" name="toggleSwitch" src="dotnetimages/collapse.gif"></img>Availability</span></h1><div id="availabilitySection" class="section" name="collapseableSection">SOLIDWORKS PDM Professional Version 5.2</div>
</div>
<div id="pagefooter"></div>
</div>
</body>
</html>