Files
pdm/documentation/api_extracted/EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmAddInMgr8~GetCAFInfo.html

187 lines
14 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>GetCAFInfo Method (IEdmAddInMgr8)</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.IEdmAddInMgr8.GetCAFInfo" />
<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.IEdmAddInMgr8~GetCAFInfo.html">Send Feedback</a></span></td>
</tr>
<tr id="pagetoptable1row2">
<td align="left" colspan="2"><span id="pagetitle">GetCAFInfo Method (IEdmAddInMgr8)</span></td>
</tr>
<tr id="pagetoptable1row3">
<td colspan="2"><a onclick="javascript:openSectionById('seeAlsoSectionHeader');" href="#seealsobookmark">
See Also</a>&nbsp;
</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.IEdmAddInMgr8.html">IEdmAddInMgr8 Interface</a>
: GetCAFInfo Method (IEdmAddInMgr8)</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="bsCAFPath_box" class="dxpopupbubble">
<DL><DT class="popupbubble"><I>bsCAFPath</I></DT>
<DD class="popupbubble">Path to the *.CAF from which to get information</DD></DL>
</div>
<div id="bsExtractPath_box" class="dxpopupbubble">
<DL><DT class="popupbubble"><I>bsExtractPath</I></DT>
<DD class="popupbubble">Path to the folder to which to extract files; ignored if empty</DD></DL>
</div>
<div id="poAddIn_box" class="dxpopupbubble">
<DL><DT class="popupbubble"><I>poAddIn</I></DT>
<DD class="popupbubble"><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmAddInInfo2.html">EdmAddInInfo2</A> structure; information about the add-in</DD></DL>
</div>
<div id="ppoFiles_box" class="dxpopupbubble">
<DL><DT class="popupbubble"><I>ppoFiles</I></DT>
<DD class="popupbubble">Array of <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmAddInFileInfo.html">EdmAddInFileInfo</A> structures, one for each file extracted from the add-in</DD></DL>
</div>
<div id="ppoCmds_box" class="dxpopupbubble">
<DL><DT class="popupbubble"><I>ppoCmds</I></DT>
<DD class="popupbubble">Array of <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmAddInMenuInfo.html">EdmAddInMenuInfo</A> structures, one for each menu command implemented by the add-in</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>
Extracts files and information from an add-in that is stored in a *.CAF that pre-dates SOLIDWORKS PDM Professional 2010.
<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>Sub GetCAFInfo( _
&nbsp;&nbsp;&nbsp;ByVal <i><a class="parameter" id="bsCAFPath" href="#" onclick="javascript:showParamBox(event);">bsCAFPath</a></i> As System.String, _
&nbsp;&nbsp;&nbsp;ByVal <i><a class="parameter" id="bsExtractPath" href="#" onclick="javascript:showParamBox(event);">bsExtractPath</a></i> As System.String, _
&nbsp;&nbsp;&nbsp;ByRef <i><a class="parameter" id="poAddIn" href="#" onclick="javascript:showParamBox(event);">poAddIn</a></i> As <a href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmAddInInfo2.html">EdmAddInInfo2</a>, _
&nbsp;&nbsp;&nbsp;ByRef <i><a class="parameter" id="ppoFiles" href="#" onclick="javascript:showParamBox(event);">ppoFiles</a></i>() As <a href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmAddInFileInfo.html">EdmAddInFileInfo</a>, _
&nbsp;&nbsp;&nbsp;ByRef <i><a class="parameter" id="ppoCmds" href="#" onclick="javascript:showParamBox(event);">ppoCmds</a></i>() As <a href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmAddInMenuInfo.html">EdmAddInMenuInfo</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>void GetCAFInfo(
&nbsp;&nbsp;&nbsp;System.string <i><a class="parameter" id="bsCAFPath" href="#" onclick="javascript:showParamBox(event);">bsCAFPath</a></i>,
&nbsp;&nbsp;&nbsp;System.string <i><a class="parameter" id="bsExtractPath" href="#" onclick="javascript:showParamBox(event);">bsExtractPath</a></i>,
&nbsp;&nbsp;&nbsp;out <a href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmAddInInfo2.html">EdmAddInInfo2</a> <i><a class="parameter" id="poAddIn" href="#" onclick="javascript:showParamBox(event);">poAddIn</a></i>,
&nbsp;&nbsp;&nbsp;out <a href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmAddInFileInfo.html">EdmAddInFileInfo</a>[] <i><a class="parameter" id="ppoFiles" href="#" onclick="javascript:showParamBox(event);">ppoFiles</a></i>,
&nbsp;&nbsp;&nbsp;out <a href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmAddInMenuInfo.html">EdmAddInMenuInfo</a>[] <i><a class="parameter" id="ppoCmds" href="#" onclick="javascript:showParamBox(event);">ppoCmds</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>void GetCAFInfo(
&&nbsp;&nbsp;&nbsp;System.String^ <i><a class="parameter" id="bsCAFPath" href="#" onclick="javascript:showParamBox(event);">bsCAFPath</a></i>,
&&nbsp;&nbsp;&nbsp;System.String^ <i><a class="parameter" id="bsExtractPath" href="#" onclick="javascript:showParamBox(event);">bsExtractPath</a></i>,
&&nbsp;&nbsp;&nbsp;[Out] <a href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmAddInInfo2.html">EdmAddInInfo2</a> <i><a class="parameter" id="poAddIn" href="#" onclick="javascript:showParamBox(event);">poAddIn</a></i>,
&&nbsp;&nbsp;&nbsp;[Out] <a href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmAddInFileInfo.html">array&lt;EdmAddInFileInfo&gt;^</a> <i><a class="parameter" id="ppoFiles" href="#" onclick="javascript:showParamBox(event);">ppoFiles</a></i>,
&&nbsp;&nbsp;&nbsp;[Out] <a href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmAddInMenuInfo.html">array&lt;EdmAddInMenuInfo&gt;^</a> <i><a class="parameter" id="ppoCmds" href="#" onclick="javascript:showParamBox(event);">ppoCmds</a></i>
) </pre></tr></table></div>
<h4 class=dxh4>Parameters</h4><DL><DT><I>bsCAFPath</I></DT>
<DD>Path to the *.CAF from which to get information</DD><DT><I>bsExtractPath</I></DT>
<DD>Path to the folder to which to extract files; ignored if empty</DD><DT><I>poAddIn</I></DT>
<DD><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmAddInInfo2.html">EdmAddInInfo2</A> structure; information about the add-in</DD><DT><I>ppoFiles</I></DT>
<DD>Array of <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmAddInFileInfo.html">EdmAddInFileInfo</A> structures, one for each file extracted from the add-in</DD><DT><I>ppoCmds</I></DT>
<DD>Array of <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.EdmAddInMenuInfo.html">EdmAddInMenuInfo</A> structures, one for each menu command implemented by the add-in</DD></DL>
</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">See the <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmAddInMgr5.html">IEdmAddInMgr5</A> examples.
</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><A href="ReturnCodes.htm">Return codes</A>:</P>
<UL>
<LI>S_OK: The method successfully executed.
<LI>E_EDM_FILE_NOT_FOUND: The specified *.CAF file was not found. </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.IEdmAddInMgr8.html">IEdmAddInMgr8 Interface</a>
<br/><a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmAddInMgr8_members.html">IEdmAddInMgr8 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 2010</div>
</div>
<div id="pagefooter"></div>
</div>
</body>
</html>