> Welcome
Welcome
Getting Started
SolidWorks API Help
FeatureWorks API Help
SolidWorks Costing API Help
SolidWorks Document Manager API Help
SolidWorks Routing API Help
SolidWorks Simulation API Help
SolidWorks Sustainability API Help
SolidWorks Toolbox API Help
SolidWorks Utilities API Help
SolidWorks Workgroup PDM API Help
eDrawings API Help
Hide Table of Contents Show Table of Contents

Welcome

This online reference guide documents the SolidWorks Application Programming Interface (API), which you can use to automate and customize the SolidWorks software.

The API contains hundreds of functions that you can call from Visual Basic for Applications (VBA), VB.NET, Visual C#, Visual C++ 6.0 , and Visual C++/CLI. These functions provide direct access to SolidWorks functionality such as creating a line, inserting an existing part into a part document, or verifying the parameters of a surface.

API Help is available on the Web or locally. To enable your desired access to API Help, select Help > Use SolidWorks Web Help. A check mark indicates that API Help is enabled on the Web.

You can find all of the SolidWorks primary interop assemblies (also referred to as just interops) in the install_dir folder. You can find the SolidWorks interops that you can redistribute with your application in:

  • install_dir\api\redist\CLR2 created with Microsoft .NET Framework Version 2.0. This is the version of interops to use with SolidWorks VSTA (VB.NET and C#) macros.
  • install_dir\api\redist created with Microsoft .NET Framework Version 4.0.

Every supported interface available in the SolidWorks API, including its associated properties and methods, is documented; undocumented SolidWorks API interfaces and functions are not supported and should not be used. Obsolete APIs are not supported. SolidWorks recommends that you use the most current version of the API.

Use of the SolidWorks API assumes that you are familiar with VBA, VB.NET, Visual C#, Visual C++ 6.0, or Visual C++/CLI.

 



Related SolidWorks Forum Content

Provide feedback on this topic

SolidWorks welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   Welcome
*Comment:  
x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2013 SP05

The search functionality within the web help is in a beta test phase and you may experience periodic delays or interruptions in its performance. These are the normal and ordinary features of a beta test and shall not under any circumstances give rise to any liability on the part of DS SolidWorks or its licensors. The topics within the Web-based help are not beta topics; they document API Help (English only) 2013 SP05.

To disable Web help from within SolidWorks and use local help instead, click Help > Use SolidWorks Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.