SOLIDWORKS PDM Professional API Help |
Release Notes
Send Feedback

Glossary Item Box

This topic provides you with quick access to the enhancements made to SOLIDWORKS PDM Professional API.

- SOLIDWORKS PDM Professional API 2024
- SOLIDWORKS PDM Professional API 2023 SP01
- SOLIDWORKS PDM Professional API 2022
- SOLIDWORKS PDM Professional API 2021 SP04
- SOLIDWORKS PDM Professional API 2021 SP03
- SOLIDWORKS PDM Professional API 2021
- SOLIDWORKS PDM Professional API 2020
- SOLIDWORKS PDM Professional API 2019 SP04
- SOLIDWORKS PDM Professional API 2019 SP03
- SOLIDWORKS PDM Professional API 2019
- SOLIDWORKS PDM Professional API 2018 SP04
- SOLIDWORKS PDM Professional API 2018 SP03
- SOLIDWORKS PDM Professional API 2018
- SOLIDWORKS PDM Professional API 2017 SP01
- SOLIDWORKS PDM Professional API 2017
- SOLIDWORKS PDM Professional API 2016
- SOLIDWORKS PDM Professional API 2015 SP04
- SOLIDWORKS PDM Professional API 2015 SP03
- SOLIDWORKS PDM Professional API 2015 SP02
- SOLIDWORKS PDM Professional API 2015
- SOLIDWORKS PDM Professional API 2014
- SOLIDWORKS PDM Professional API 2013
- SOLIDWORKS PDM Professional API 2012
- SOLIDWORKS PDM Professional API 2011
- SOLIDWORKS PDM Professional API 2010
- SOLIDWORKS PDM Professional API 2009
- SOLIDWORKS PDM Professional API 2008
- SOLIDWORKS PDM Professional API 2007 SP03
- SOLIDWORKS PDM Professional API 2007
- SOLIDWORKS PDM Professional API version 6.5
- SOLIDWORKS PDM Professional API version 6.4
- SOLIDWORKS PDM Professional API version 6.3

###### SOLIDWORKS PDM Professional API 2024

#### New interfaces and methods

- IEdmBatchChangeState6
- IEdmVault22::ADRunSync
- IEdmVault22::ClearLogs
- IEdmVault22::GetColumnSets
- IEdmVault22::GetCurrentColumnSet
- IEdmVault22::SetColumnSetID

#### New structure

- EdmColumnSet

###### SOLIDWORKS PDM Professional API 2023 SP01

#### New interface and method

- IEdmFile18::GetThumbnail3 (retrieves a file's thumbnail handle; obsoletes IEdmFile15::GetThumbnail2)

###### SOLIDWORKS PDM Professional API 2022

#### New interfaces

- IEdmBomView4 (rename a named BOM)
- IEdmFolder13 (destroy deleted files by specifying EDMDeletedItems)
- IEdmSerNoGen8 (set the next counter value for serial numbers)
- IEdmUser11 (specify user settings)
- IEdmUserGroup9 (specify user group settings)

###### SOLIDWORKS PDM Professional API 2021 SP04

#### New interface

- IEdmRefItem2 (get old and new paths for references that have been moved or renamed by another client)

#### New structure

- EdmUpdatedRefPath

###### SOLIDWORKS PDM Professional API 2021 SP03

#### New interfaces

- IEdmBomMgr3 (create a SOLIDWORKS BOM with any number of rows and columns and add it to a non-SOLIDWORKS document)
- IEdmSWBom
- IEdmSWBomCell
- IEdmSWBomColumn
- IEdmSWBomRow

###### SOLIDWORKS PDM Professional API 2021

#### New functionality and interfaces

- Ability to display minor progress during callbacks. See IEdmCallback8.
- Ability to retrieve results of a specified favorite search. See IEdmSearch10 and IEdmSearchResult6.

###### SOLIDWORKS PDM Professional API 2020

#### New functionality and interfaces

- Support for BOM in Web 2. Get whether a specified user has permission to see a specified layout and get all of the BOM layouts in the vault. See IEdmBomMgr2::CanSeeBomLayout and IEdmBomMgr2::GetBomLayouts2.
- Support for file history in Web 2. Get the sorted history and the event description for a specified history item. See IEdmHistory3::GetEventDescription and IEdmHistory3::GetSortedHistory.
- Extended search functionality includes the ability to:
  - Create an extended search object. See IEdmVault21::CreateSearch2.
  - Use new search syntax. See Search Syntax.
  - Add a multi-variable search condition. See IEdmSearch9::AddMultipleVariableCondition.
  - Get search syntax errors. See IEdmSearch9::GetSyntaxErrors.
  - Use search syntax in existing IEdmSearch* properties and method parameters. See IEdmSearch5::FileName, IEdmSearch5::VersionComment, IEdmSearch5::State, IEdmSearch6::SetToken, and IEdmSearch8::AddVariable2.
- Get whether a document has cut list items. See IEdmFile17::HasCutlistItems.
- Get and set whether focus is on the data card view. See IEdmCardView64::IsFocusOnDataCard and IEdmCardView64::SetFlagIsFocusOnDataCard.
- Get whether a BOM row is a virtual component. See IEdmBomCell2::IsVirtual.

#### New structure

- EdmBomLayout2

###### SOLIDWORKS PDM Professional API 2019 SP04

#### New functionality and interface

- Create a file label. See IEdmFile16::CreateLabel.

###### SOLIDWORKS PDM Professional API 2019 SP03

#### New functionality and interface

- Get all controls in a file or folder data card. See IEdmCard7:GetAllControls.

###### SOLIDWORKS PDM Professional API 2019

#### New functionality and interfaces

- Add users by login type to the vault. See IEdmUserMgr10::AddUsers3.
- Get whether a specified user must add a state change comment for specified workflow transitions for specified documents. See IEdmVault20::GetTransitionCommentPermissions.
- Get specified files from a vault. See IEdmVault20::GetFiles.
- Get the archive server log. See IEdmVault20::GetArchiveServerLog.

#### New structure

- EdmDocIds

Back to top

###### SOLIDWORKS PDM Professional API 2018 SP04

#### New functionality and interfaces

- Get and run a task add-in that is installed in the Administration tool. See IEdmTaskMgr.
- Get a file's thumbnail by file version. See IEdmFile15::GetThumbnail2.

#### New structure

- EdmTaskInfo

###### SOLIDWORKS PDM Professional API 2018 SP03

#### New functionality and interfaces

- Create configuration values for drawings or other files lacking properties at the configuration level. See IEdmFile14::GenerateDefaultConfigValues.
- Get the ID of the view in which a file is checked out. See IEdmFile14::LockedOnViewID.

###### SOLIDWORKS PDM Professional API 2018

#### New functionality and interfaces

- Remove a PDM add-in. See IEdmAddInMgr9.
- Get a list of values associated with a drop-down control on a data card. See IEdmCardControl7.
- Add custom tabs to a PDM vault view in File Explorer using a PDM add-in. The add-in:
  - implements hooks to allow third-parties to display their user interfaces in a custom tab.
  - supports custom tab names and icons.
  - supports multiple custom tabs.
  - programmatically removes custom tabs.
  - See IEdmCmdMgr6.
- Change the state of a file using a specific transition. See IEdmFile13.
- Get the thumbnail of a file. See IEdmFile13.
- Restore deleted items from the recycle bin to the vault view. See IEdmFolder11.
- Construct more complicated search criteria using comparators and boolean operators. See IEdmSearch8.
- Call the Set Revision command to update a revision table in a SOLIDWORKS drawing in this vault. See IEdmVault19.
- Copy an assembly tree of referenced parts and drawings to a destination folder. See IEdmVault19

#### New structures

- EdmCopyTreeOptions
- EdmDeletedItems
- EdmSimpleXRefInfo

###### SOLIDWORKS PDM Professional API 2017 SP01

#### New interfaces

- IEdmVault18

###### SOLIDWORKS PDM Professional API 2017

#### New interfaces

- IEdmBatchListing4
- IEdmBomView3
- IEdmEnumeratorCustomReference7
- IEdmEnumeratorVersion7
- IEdmFile12
- IEdmFolder10
- IEdmHistory2
- IEdmRevision7
- IEdmTemplate6
- IEdmUserMgr9
- IEdmVersion8
- IEdmVault17

#### New structures

- EdmListFile2
- EdmStatePermission
- EdmTransitionPermission

###### SOLIDWORKS PDM Professional API 2016

- SOLIDWORKS Enterprise PDM is now called SOLIDWORKS PDM, and the API is only available in SOLIDWORKS PDM Professional.

#### New interfaces

- IEdmFolder9
- IEdmReference11
- IEdmVault16

###### SOLIDWORKS PDM Professional API 2015 SP04

#### New interfaces

- IEdmBatchChangeState5
- IEdmEnumeratorVariable10

###### SOLIDWORKS PDM Professional API 2015 SP03

#### New interface

- IEdmVault15

Back to top

###### SOLIDWORKS PDM Professional API 2015 SP02

#### New interfaces

- IEdmBatchChangeState4
- IEdmCardControl6
- IEdmFile10
- IEdmFile11
- IEdmTransition10

Back to top

###### SOLIDWORKS PDM Professional API 2015

- In:
- - 2015 SP0 and later, licenses are shared among all vaults that use the same SolidNetwork License Server (SNL). See IEdmVault14::InstallLicense2.
  - 2014 and earlier, licenses were shared among all vaults that were in the same SQL Server instance. IEdmVault14::InstallLicense2 obsoletes and replaces IEdmVault11::InstallLicense.I
- Includes a new primary interop assembly (also called an interop) called EPDM.Interop.EPDMResultCode.dll for return codes and for use with stand-alone applications. See Using .NET Framework 4.0 in Stand-alone Applications for more information.

#### New interfaces

- IEdmEnumeratorVersion6
- IEdmFile9
- IEdmFolder8
- IEdmReference10
- IEdmRevision6
- IEdmVault14
- IEdmVersion6
- IEdmVersion7

###### SOLIDWORKS PDM Professional API 2014

- SOLIDWORKS Enterprise PDM API Help has been upgraded to be consistent with all of the other SOLIDWORKS API Help systems. For example, SOLIDWORKS Enterprise PDM API Help now includes syntax for VB.NET, C#, and managed C++ and a Send Feedback link on most Help topics. Additionally, SOLIDWORKS Enterprise PDM API Help:
  - contains updated Stand-alone Applications and Add-in Applications books and Help topics.
  - includes C# and VB.NET add-in and stand-alone code samples that you can recreate in Microsoft Visual Studio. If you use the local version of SOLIDWORKS Enterprise PDM API Help, then click the Index tab and type C# add-ins, C# examples, VB.NET add-ins, or VB.NET examples to quickly locate these examples. Additional examples will appear in subsequent releases.
  - is now available on the:
    - SOLIDWORKS Help menu, Help > API Help > SOLIDWORKS Enterprise PDM API Help.
    - internet, help.solidworks.com > API Help (English only) > SOLIDWORKS Enterprise PDM API Help.
  - SOLIDWORKS Enterprise PDM includes a primary interop assembly (also called an interop) called EPDM.Interop.epdm.dll for use with stand-alone applications. See Using .NET Framework 4.0 in Stand-alone Applications for more information.
- Any application not supplied and supported by SOLIDWORKS Corporation that logs into SOLIDWORKS Enterprise PDM or directly accesses the database must ensure that sufficient SOLIDWORKS Enterprise PDM licenses are available when the same user is not logged into a local view.
  To make this easier to program and to comply with the SOLIDWORKS End User License Agreement (EULA), SOLIDWORKS Enterprise PDM API 2014 includes a new login method called IEdmVault13::LoginEx. This method ensures that licenses are properly consumed by the application.

#### New structure

- EdmListRef

#### New method

- IEdmVault13::LoginEx

Back to top

###### SOLIDWORKS PDM Professional API 2013

#### New interfaces

- IEdmAddCustomRefs2
- IEdmBatchUnlock2
- IEdmEnum
- IEdmEnumeratorCustomReference6
- IEdmFindUser
- IEdmImage
- IEdmTransition8
- IEdmUser10
- IEdmUserMgr8
- IEdmBatchChangeState2

Back to top

###### SOLIDWORKS PDM Professional API 2012

#### New interfaces

- IEdmBatchDelete3
- IEdmFolder7

Back to top

###### SOLIDWORKS PDM Professional API 2011

#### New interfaces

- IEdmCmdNode
- IEdmLabel6
- IEdmMenu7
- IEdmUpdateReferences
- IEdmVariableMgr7
- IEdmGetOpCallback2
- IEdmReference8
- IEdmReference9
- IEdmState7
- IEdmTransition7
- IEdmUser8
- IEdmUserGroup7
- IEdmVault12

Back to top

###### SOLIDWORKS PDM Professional API 2010

#### New functionality

You can now program items and tasks.

#### New interfaces

- IEdmAddInMgr8
- IEdmBatchItemGeneration
- IEdmBatchItemGeneration2
- IEdmBatchItemReferenceUpdate
- IEdmBatchRefVars
- IEdmClearLocalCache2
- IEdmFile8
- IEdmItem
- IEdmReference7
- IEdmSelectionList6
- IEdmTaskInstance
- IEdmTaskProperties
- IEdmUser7
- IEdmUserGroup6
- IEdmUserMgr7
- IEdmVault11

Back to top

###### SOLIDWORKS PDM Professional API 2009

#### New interfaces

- IEdmBatchAdd2
- IEdmBatchChangeState
- IEdmBatchDelete2
- IEdmBatchListing2
- IEdmBom
- IEdmBomCell
- IEdmBomMgr
- IEdmBomView
- IEdmFile7
- IEdmMenu6

Back to top

###### SOLIDWORKS PDM Professional API 2008

#### New and changed functionality

- Visual Basic 6 is no longer supported. All add-ins must now be multi-threaded; for example, create your add-ins using the Visual Studio .NET development environment.
- The recommended way of accessing variables has changed. See IEdmEnumeratorVariable8::CloseFile.

#### New interfaces

- IEdmBatchDelete
- IEdmClearLocalCache
- IEdmAddInMgr7
- IEdmHistoryUpdate
- IEdmEnumeratorVariable8

  Back to top

###### SOLIDWORKS PDM Professional API 2007 SP03

#### New functionality

Support for 64-bit add-ins for the 64-bit version is included in this release.

#### New interface

- IEdmRevisionMgr2

###### SOLIDWORKS PDM Professional API 2007

#### New interfaces

- IEdmRevisionMgr
- IEdmSearch6
- IEdmUserMgr6
- IEdmVariableMgr6

Back to top

###### SOLIDWORKS PDM Professional API version 6.5

Conisio has been re-branded as SOLIDWORKS Enterprise PDM; however, an OEM-version of the product sold under the name Conisio still exists. Both of these products share the same API.

#### New and changed functionality

- The name of the type library has changed from ConisioLib to EdmLib.
- The name of the API has changed from Conisio 6.4 Type Library to PDMWorks Enterprise 6.5 Type Library.
  NOTE: The change in the name of the type library might require you to recompile existing applications. However, the names of all interfaces, structures, methods, properties, and enumerations are unchanged.

Back to top

###### SOLIDWORKS PDM Professional version 6.4

#### New functionality

- Debugging add-ins has improved.
- You can create add-ins:
  - using the Microsoft Visual Studio.NET development environment.
  - that add menu commands to the SOLIDWORKS PDM Professional Administration tool menu.

#### New interfaces

- IEdmBatchAdd
- IEdmBatchListing
- IEdmCard6
- IEdmHistory
- IEdmRawReferenceMgr
- IEdmRefItem
- IEdmRefItemContainer
- IEdmSerNoGen7
- IEdmSerNoValue
- IEdmVariableValue6
- IEdmVault8

Back to top

###### SOLIDWORKS PDM Professional API version 6.3

#### New interfaces

- IEdmAddCustomRefs
- IEdmBatchAddFolders
- IEdmBatchGet
- IEdmBatchUnlock
- IEdmBatchUpdate2
- IEdmCardView63
- IEdmUnlockOpCallback

  Back to top