206 lines
17 KiB
HTML
206 lines
17 KiB
HTML
<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>GetFirstChildPosition4 Method (IEdmReference10)</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.IEdmReference10.GetFirstChildPosition4" />
|
|
<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.IEdmReference10~GetFirstChildPosition4.html">Send Feedback</a></span></td>
|
|
</tr>
|
|
|
|
<tr id="pagetoptable1row2">
|
|
<td align="left" colspan="2"><span id="pagetitle">GetFirstChildPosition4 Method (IEdmReference10)</span></td>
|
|
</tr>
|
|
|
|
<tr id="pagetoptable1row3">
|
|
<td colspan="2"><a onclick="javascript:openSectionById('seeAlsoSectionHeader');" href="#seealsobookmark">
|
|
See Also</a>
|
|
<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.IEdmReference10.html">IEdmReference10 Interface</a>
|
|
: GetFirstChildPosition4 Method (IEdmReference10)</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="pbsProjectName_box" class="dxpopupbubble">
|
|
<DL><DT class="popupbubble"><I>pbsProjectName</I></DT>
|
|
<DD class="popupbubble">Project name (see <STRONG>Remarks</STRONG>)</DD></DL>
|
|
</div>
|
|
<div id="bIsTopParent_box" class="dxpopupbubble">
|
|
<DL><DT class="popupbubble"><I>bIsTopParent</I></DT>
|
|
<DD class="popupbubble">True if this is the topmost node in the reference tree, false if not</DD></DL>
|
|
</div>
|
|
<div id="bPermitReadLocal_box" class="dxpopupbubble">
|
|
<DL><DT class="popupbubble"><I>bPermitReadLocal</I></DT>
|
|
<DD class="popupbubble">True to allow SOLIDWORKS PDM Professional to read reference information if it is not already present in the database, false to disallow SOLIDWORKS PDM Professional to read reference information if it is not already present in the database</DD></DL>
|
|
</div>
|
|
<div id="bGetSuppressedComponent_box" class="dxpopupbubble">
|
|
<DL><DT class="popupbubble"><I>bGetSuppressedComponent</I></DT>
|
|
<DD class="popupbubble">True to get a suppressed reference, false to not</DD></DL>
|
|
</div>
|
|
<div id="lEdmRefFlags_box" class="dxpopupbubble">
|
|
<DL><DT class="popupbubble"><I>lEdmRefFlags</I></DT>
|
|
<DD class="popupbubble">Types of references that you want enumerated as defined in <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmRefFlags.html">EdmRefFlags</A></DD></DL>
|
|
</div>
|
|
<div id="bsConfiguration_box" class="dxpopupbubble">
|
|
<DL><DT class="popupbubble"><I>bsConfiguration</I></DT>
|
|
<DD class="popupbubble">Configuration name for which to get child references (see <STRONG>Remarks</STRONG>)</DD></DL>
|
|
</div>
|
|
<div id="lVersion_box" class="dxpopupbubble">
|
|
<DL><DT class="popupbubble"><I>lVersion</I></DT>
|
|
<DD class="popupbubble">Version for which to get references; use 0 for 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>
|
|
Starts an enumeration of child references for the specified configuration.
|
|
|
|
|
|
<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> </th></tr><tr><td colspan="2"><pre>Function GetFirstChildPosition4( _
|
|
ByRef <i><a class="parameter" id="pbsProjectName" href="#" onclick="javascript:showParamBox(event);">pbsProjectName</a></i> As System.String, _
|
|
ByVal <i><a class="parameter" id="bIsTopParent" href="#" onclick="javascript:showParamBox(event);">bIsTopParent</a></i> As System.Boolean, _
|
|
ByVal <i><a class="parameter" id="bPermitReadLocal" href="#" onclick="javascript:showParamBox(event);">bPermitReadLocal</a></i> As System.Boolean, _
|
|
ByVal <i><a class="parameter" id="bGetSuppressedComponent" href="#" onclick="javascript:showParamBox(event);">bGetSuppressedComponent</a></i> As System.Boolean, _
|
|
ByVal <i><a class="parameter" id="lEdmRefFlags" href="#" onclick="javascript:showParamBox(event);">lEdmRefFlags</a></i> As System.Integer, _
|
|
ByVal <i><a class="parameter" id="bsConfiguration" href="#" onclick="javascript:showParamBox(event);">bsConfiguration</a></i> As System.String, _
|
|
Optional ByVal <i><a class="parameter" id="lVersion" href="#" onclick="javascript:showParamBox(event);">lVersion</a></i> As System.Integer _
|
|
) As <a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmPos5.html">IEdmPos5</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> </th></tr><tr><td colspan="2"><pre><a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmPos5.html">IEdmPos5</a> GetFirstChildPosition4(
|
|
out System.string <i><a class="parameter" id="pbsProjectName" href="#" onclick="javascript:showParamBox(event);">pbsProjectName</a></i>,
|
|
System.bool <i><a class="parameter" id="bIsTopParent" href="#" onclick="javascript:showParamBox(event);">bIsTopParent</a></i>,
|
|
System.bool <i><a class="parameter" id="bPermitReadLocal" href="#" onclick="javascript:showParamBox(event);">bPermitReadLocal</a></i>,
|
|
System.bool <i><a class="parameter" id="bGetSuppressedComponent" href="#" onclick="javascript:showParamBox(event);">bGetSuppressedComponent</a></i>,
|
|
System.int <i><a class="parameter" id="lEdmRefFlags" href="#" onclick="javascript:showParamBox(event);">lEdmRefFlags</a></i>,
|
|
System.string <i><a class="parameter" id="bsConfiguration" href="#" onclick="javascript:showParamBox(event);">bsConfiguration</a></i>,
|
|
System.int <i><a class="parameter" id="lVersion" href="#" onclick="javascript:showParamBox(event);">lVersion</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> </th></tr><tr><td colspan="2"><pre><a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmPos5.html">IEdmPos5^</a> GetFirstChildPosition4(
|
|
& [Out] System.String^ <i><a class="parameter" id="pbsProjectName" href="#" onclick="javascript:showParamBox(event);">pbsProjectName</a></i>,
|
|
& System.bool <i><a class="parameter" id="bIsTopParent" href="#" onclick="javascript:showParamBox(event);">bIsTopParent</a></i>,
|
|
& System.bool <i><a class="parameter" id="bPermitReadLocal" href="#" onclick="javascript:showParamBox(event);">bPermitReadLocal</a></i>,
|
|
& System.bool <i><a class="parameter" id="bGetSuppressedComponent" href="#" onclick="javascript:showParamBox(event);">bGetSuppressedComponent</a></i>,
|
|
& System.int <i><a class="parameter" id="lEdmRefFlags" href="#" onclick="javascript:showParamBox(event);">lEdmRefFlags</a></i>,
|
|
& System.String^ <i><a class="parameter" id="bsConfiguration" href="#" onclick="javascript:showParamBox(event);">bsConfiguration</a></i>,
|
|
& System.int <i><a class="parameter" id="lVersion" href="#" onclick="javascript:showParamBox(event);">lVersion</a></i>
|
|
) </pre></tr></table></div>
|
|
|
|
<h4 class=dxh4>Parameters</h4><DL><DT><I>pbsProjectName</I></DT>
|
|
<DD>Project name (see <STRONG>Remarks</STRONG>)</DD><DT><I>bIsTopParent</I></DT>
|
|
<DD>True if this is the topmost node in the reference tree, false if not</DD><DT><I>bPermitReadLocal</I></DT>
|
|
<DD>True to allow SOLIDWORKS PDM Professional to read reference information if it is not already present in the database, false to disallow SOLIDWORKS PDM Professional to read reference information if it is not already present in the database</DD><DT><I>bGetSuppressedComponent</I></DT>
|
|
<DD>True to get a suppressed reference, false to not</DD><DT><I>lEdmRefFlags</I></DT>
|
|
<DD>Types of references that you want enumerated as defined in <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmRefFlags.html">EdmRefFlags</A></DD><DT><I>bsConfiguration</I></DT>
|
|
<DD>Configuration name for which to get child references (see <STRONG>Remarks</STRONG>)</DD><DT><I>lVersion</I></DT>
|
|
<DD>Version for which to get references; use 0 for latest version</DD></DL>
|
|
|
|
<h4 class=dxh4>Return Value</h4><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmPos5.html">Position</A> of the first file referenced by this file (see <STRONG>Remarks</STRONG>)</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_VBNET.htm">Get File References for a File (VB.NET)</a>
|
|
<br/><a href="Get_File_References_for_File_Example_CSharp.htm">Get File References for a File (C#)</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>You should maintain and pass in a string, by reference, in this argument for all calls to this method in a reference tree. The project name can be allocated and returned by the topmost node in the tree and is used by its children.</P>
|
|
<P><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmReference6~RefCount.html">IEdmReference6::RefCount</A> and <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmReference8~RefCountEdited.html">IEdmReference8::RefCountEdited</A> for child references return values for corresponding referenced configurations. If an empty string is passed to bsConfiguration, then the file's common configuration is used.</P>
|
|
<P>Pass the position returned by this method to <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmReference5~GetNextChild.html">IEdmReference5::GetNextChild</A> to continue to enumerate the referenced files.</P>
|
|
<P>C++ programmers not using smart-pointer wrapper functions must release the position.</P>
|
|
<P><A href="ReturnCodes.htm">Return code</A> S_OK indicates that the method successfully executed.</P></div>
|
|
<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.IEdmReference10.html">IEdmReference10 Interface</a>
|
|
<br/><a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmReference10_members.html">IEdmReference10 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 2015</div>
|
|
</div>
|
|
|
|
<div id="pagefooter"></div>
|
|
</div>
|
|
</body>
|
|
</html> |