Files
pdm/documentation/api_extracted/GettingStarted-epdmapi.html

135 lines
7.9 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html xmlns:innovasys 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 name="GENERATOR" content="Innovasys HelpStudio (http://www.innovasys.com)" />
<title>Getting Started</title>
<link rel="stylesheet" type="text/css" href="stylesheets/helpstudio.css" />
<link rel="stylesheet" type="text/css" href="stylesheets/hs-boxes.css"></link>
<link rel="stylesheet" type="text/css" href="stylesheets/hs-expandcollapse.css"></link>
<link rel="stylesheet" type="text/css" href="stylesheets/hs-simpletab.css"></link>
<link rel="stylesheet" type="text/css" href="stylesheets/hs-heading-expandcollapse.css"></link>
<link rel="stylesheet" type="text/css" href="stylesheets/hs-tabstrip.css"></link>
<link rel="stylesheet" type="text/css" href="ApiHelp.css"></link>
<script src="script/helpstudio.js" type="text/javascript"></script>
<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>
<style type=text/css>div#pagetop, div#pagetop table td, span#projecttitle, span#pagetitle {background-color: #CCCCFF}</style>
</head>
<body id="hsbody">
<div style="display: none">
<input type="hidden" id="userDataCache" class="userDataStyle" name="userDataCache" />
<input type="hidden" id="hiddenScrollOffset" name="hiddenScrollOffset" />
</div>
<img id="collapseImage" style="display:none; height:0; width:0;" src="images/collapse.gif">
<img id="expandImage" style="display:none; height:0; width:0;" src="images/expand.gif"/>
<img id="copyImage" style="display:none; height:0; width:0;" src="images/copycode.gif"/>
<img id="copyHoverImage" style="display:none; height:0; width:0;" src="images/copycodeHighlight.gif">
<img id="dropDownImage" style="display:none; height:0; width:0;" src="images/drpdown.gif"/>
<img id="dropDownHoverImage" style="display:none; height:0; width:0;" src="images/drpdown_orange.gif"/>
<div id="pagetop">
<table width="100%" id="pagetoptable2" cellspacing="0" cellpadding="0">
<tr>
<td></td>
</tr>
</table>
<table width="100%" id="pagetoptable1">
<tr id="pagetoptable1row1">
<td align="left">
<span id="projecttitle">
SOLIDWORKS PDM Professional API Help
</span>
</td>
<td align="right" rowspan="2">
</td>
</tr>
<tr id="pagetoptable1row2">
<td align="left">
<span id="pagetitle">
Getting Started
</span>
</td>
</tr>
<tr id="pagetoptable1row3">
<td colspan="2">
<span id="feedbacklink"><a href="mailto:apihelp.feedback@3ds.com?subject=Documentation Feedback: GettingStarted-epdmapi.html">Send Feedback</a></span>
</td>
</tr>
</table>
</div>
<div class="hspopupbubble" id="hsglossaryitembox">
<p>Glossary Item Box</p>
</div>
<div id="pagebody">
<div id="mainbody">
<H4>SOLIDWORKS PDM Professional Application Programming Interface</H4>
<P>SOLIDWORKS PDM Professionals application programming interface (API)&nbsp;gives you access to most of the functionality in SOLIDWORKS PDM Professional. For example, you can programmatically:</P>
<UL>
<LI>Manage:
<UL>
<LI><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmVault5.html">Vaults</A> and their <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmVault11~CreateNewVaultView.html">views</A>
<LI><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmUserMgr5.html">Users</A> and <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmUserGroup5.html">user groups</A>
<LI>File and folder <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmCard5.html">cards</A> and their <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmCardView5.html">views</A>
<LI><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmReference5.html">File references</A>
<LI><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmVariableMgr5.html">Card variables</A> and <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmAttribute5.html">attributes</A>
<LI><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmWorkflow6.html">Workflows</A>, <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmState5.html">states</A>, and <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmTransition5.html">transitions</A>
<LI><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmTaskInstance.html">Tasks</A></LI></UL>
<LI>Access:
<UL>
<LI>Vault <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmItem.html">items</A>
<LI><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmHistory.html">History</A> of files and folders
<LI><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmVersion5.html">Versions</A> and <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmRevision5.html">revisions</A> of files
<LI><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmTemplateMgr5.html">Templates</A> installed&nbsp;in the vault</LI></UL>
<LI><A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmSearch5.html">Search</A> vaults and browse vault <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmFolder5.html">folders</A>
<LI>Check files <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmBatchUnlock.html">in</A> and <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmBatchGet.html">out</A> of the vault
<LI>Send <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmInbox5.html">messages</A> to users
<LI>Create <A href="EPDM.Interop.epdm~EPDM.Interop.epdm.IEdmAddIn5.html">add-ins</A></LI></UL>
<P>See the <A href="ReleaseNotes-epdmapi.html">Release Notes</A> for the updates made to recent releases of the SOLIDWORKS PDM Professional API.</P>
<H4>Applications&nbsp;</H4>
<P>You can write two types of applications using this API:</P>
<OL>
<LI><A href="StandAloneApp.htm">Stand-alone applications</A> (<STRONG>.exe</STRONG>&nbsp;and <STRONG>.dll</STRONG>) that are called by other programs to use various features&nbsp;of SOLIDWORKS PDM Professional.
<LI><A href="AddInApp.htm">Add-in applications</A> that are called by SOLIDWORKS PDM Professional when users perform actions&nbsp;like check&nbsp;in or check out of&nbsp;a file, add a file to the vault, change the state of a file, etc. <A id=interop name=interop></A></LI></OL>
<H4>Primary Assembly <SPAN id=dxMisspelled word="Interops" reason="spell">Interops</SPAN></H4>
<P>SOLIDWORKS PDM Professional includes two&nbsp;primary interop assemblies&nbsp;(also called interops) for use with stand-alone SOLIDWORKS PDM Professional applications:</P>
<UL>
<LI><STRONG>EPDM.Interop.epdm.dll</STRONG>
<LI><STRONG>EPDM.interop.EPDMResultCode.dll</STRONG></LI></UL>
<P>The interops are stored in the top folder of your SOLIDWORKS PDM Professional installation.</P>
<UL>
<LI>32-bit&nbsp;interops&nbsp;are shipped with the&nbsp;32-bit&nbsp;version of SOLIDWORKS PDM Professional.
<LI>64-bit interops are shipped with the&nbsp;64-bit version of SOLIDWORKS PDM Professional.</LI></UL>
<P>See <A href="Using_NET_Framework_in_Applications.htm">Using .NET Framework 4.0 in Stand-alone Applications</A> for more information.</P>
<H4>See Also</H4>
<P><A href="ReturnCodes.htm">Return Codes</A></P>
<P><A href="Troubleshooting_Guide.htm">TroubleShooting Guide</A></P>
<a name="seealsobookmark"></a>
</div>
<div id="pagefooter">
</div>
</div>
</body>
</html>