163 lines
13 KiB
HTML
163 lines
13 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>IEdmVault5 Interface</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.IEdmVault5" />
|
|
<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.IEdmVault5.html">Send Feedback</a></span></td>
|
|
</tr>
|
|
|
|
<tr id="pagetoptable1row2">
|
|
<td align="left" colspan="2"><span id="pagetitle">IEdmVault5 Interface</span></td>
|
|
</tr>
|
|
|
|
<tr id="pagetoptable1row3">
|
|
<td colspan="2"><a onclick="javascript:openSectionById('seeAlsoSectionHeader');" href="#seealsobookmark">
|
|
See Also</a>
|
|
<a href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmVault5_members.html">Members</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>
|
|
: IEdmVault5 Interface</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>
|
|
|
|
<div id="pagebody" valign="bottom">
|
|
<a name="topBookmark"></a>
|
|
|
|
<div id="mainbody">
|
|
<div class="saveHistory" id="allHistory" onsave="saveAll()" onload="loadAll()"></div>
|
|
<P>Allows you to access a file vault.</P>
|
|
</br><b>NOTE:</b> Click the <b>Members</b> link, located near the top of the topic, to see this interface's methods and properties.</br>
|
|
<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>Public Interface IEdmVault5 </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>public interface IEdmVault5 </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>public interface class IEdmVault5 </pre></tr></table></div>
|
|
</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="Destroy_Deleted_Files_in_Vault_Example_CSharp.htm">Destroy Deleted Files in Vault (C#)</a>
|
|
<br/><a href="Destroy_Deleted_Files_in_Vault_Example_VBNET.htm">Destroy Deleted Files in Vault (VB.NET)</a>
|
|
<br/><a href="Get_and_Set_Folder_Permissions_Example_CSharp.htm">Get and Set Folder Permissions (C#)</a>
|
|
<br/><a href="Get_and_Set_Folder_Permissions_Example_VBNET.htm">Get and Set Folder Permissions (VB.NET)</a>
|
|
<br/><a href="Traverse_Folders_and_Files_in_Vault_Example_CSharp.htm">Traverse Folders and Files in Vault (C#)</a>
|
|
<br/><a href="Traverse_Folders_and_Files_in_Vault_Example_VBNET.htm">Traverse Folders and Files in Vault (VB.NET)</a>
|
|
<br/><a href="Change_Card_Variables_Addin_Example_VBNET.htm">Change Card Variables Add-in (VB.NET)</a>
|
|
<br/><a href="Change_Card_Variables_Addin_Example_CSharp.htm">Change Card Variables Add-in (C#)</a>
|
|
<br/><a href="Schedule_Task_to_Find_Files_in_State_Addin_Example_VBNET.htm">Create a Task that Finds Files in Workflow States (VB.NET)</a>
|
|
<br/><a href="Schedule_Task_to_Find_Files_in_State_Addin_Example_CSharp.htm">Create a Task that Finds Files in Workflow States (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>This interface represents a SOLIDWORKS PDM Professional file vault. It is the highest-level interface within this API; most of the other interfaces in this API are retrieved from this interface either directly or indirectly.</P>
|
|
<P><A href="StandAloneApp.htm">Standalone program</A>s using this API should first declare and create an instance of this interface. Because interfaces are abstract definitions and not implementations, they cannot be created directly using the <STRONG>New</STRONG> keyword.</P>
|
|
<P>The type library includes a creatable class called EdmVault5, which implements the IEdmVault5 interface.</P>
|
|
<P>You can create an instance of the EdmVault5 class with the <STRONG>New</STRONG> keyword, and because this class implements the IEdmVault5 interface, you can reference it with the variable declared as IEdmVault5 interface type. By convention, interface names begin with an uppercase letter I. Once the IEdmVault5 interface object is created, most of the other interface objects within this API are returned either directly or indirectly by methods and properties of the IEdmVault5 object or some other object that originated from it. Add-in programs are passed an IEdmVault5 object when the add-in is loaded and when needed.</P>
|
|
<P>To access this interface, stand-alone programs can:</P>
|
|
<UL>
|
|
<LI>Obtain an instance through one of the accessors.
|
|
<LI>Create an instance:</LI></UL>
|
|
<BLOCKQUOTE style="MARGIN-RIGHT: 0px" dir=ltr><PRE>Dim vault as EdmVault5 <BR>vault = new EdmVault5
|
|
</PRE></BLOCKQUOTE>
|
|
<P dir=ltr> </P>
|
|
<P dir=ltr>After obtaining an instance, programs must call <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmVault5~Login.html">IEdmVault5::Login</A> or <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmVault5~LoginAuto.html">IEdmVault5::LoginAuto</A> to establish a connection with the file vault.</P>
|
|
<P>This interface:</P>
|
|
<UL>
|
|
<LI>inherits from IDispatch. See <A href="http://msdn.microsoft.com/en-us/library/windows/desktop/ms221608(v=vs.85).aspx" target=_blank>IDispatch Interface (Automation)</A>.
|
|
<LI>is extended by <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmVault6.html">IEdmVault6</A>. </LI></UL></div>
|
|
<h1 class="heading"><span class="expandcollapse" tabindex="0"><img id="accessorsToggle" class="toggle" name="toggleSwitch" src="dotnetimages/collapse.gif"></img>Accessors</span></h1><div id="accessorsSection" class="section" name="collapseableSection"><P><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmAddIn5~GetAddInInfo.html">IEdmAddIn5::GetAddInInfo</A></P>
|
|
<P><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFile5~Vault.html">IEdmFile5::Vault</A></P>
|
|
<P><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFolder5~Vault.html">IEdmFolder5::Vault</A></P>
|
|
<P><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmObject5~Vault.html">IEdmObject5::Vault</A></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.IEdmVault5_members.html">IEdmVault5 Members</a>
|
|
<br/><a href="EPDM.Interop.epdm~EPDM.Interop.epdm_namespace.html">EPDM.Interop.epdm Namespace</a>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="pagefooter"></div>
|
|
</div>
|
|
</body>
|
|
</html> |