SOLIDWORKS API

https://help.solidworks.com/2026/english/api
Admin
SOLIDWORKS API is a comprehensive application programming interface that enables automation and...
Tokens:24,196,807
Snippets:174,160
Trust Score:9.5
Update:3 days ago
Show doc for...
Tokens:
Raw
### Get Guide Curves in Loft Feature Example (VB.NET)

Source: https://help.solidworks.com/2026/english/api/sldworksapi/Get_Guide_Curves_in_Loft_Feature_Example_VBNET.htm

This script creates a new part, builds a loft feature with a guide curve, and outputs the feature's properties and guide curve details to the Immediate window.

```vbnet
'----------------------------------------
'  Preconditions:
'  1.  Verify  that  the  specified  part  document
'     template  exists.
'  2.  Open  the  Immediate  window.
'
'  Postconditions:
'  1.  Creates  a  new  part  document.
'  2.  Creates  a  loft  feature.
'  3.  Prints  to  the  Immediate  window
'     the  feature  type  and  feature  name  of  the  loft  
'     feature.
'  4.  Accesses  the  guide  curves  in  the  loft  feature.
'  5.  Prints  to  the  Immediate  window  whether  the
'     loft  is  a  boss  feature,  the  number  guide
'     curves  in  the  loft,  and  the  feature  types  of  the  
'    guide  curves.
'  6.  Releases  access  to  the  loft  feature.
'  7.  Examine  the  Immediate  window.
'----------------------------------------
Imports  SolidWorks.Interop.sldworks
Imports  SolidWorks.Interop.swconst
Imports  System.Runtime.InteropServices
Imports  System
Imports  System.Diagnostics
 
Partial  Class  SolidWorksMacro
 
    Dim  swModel  As  ModelDoc2
    Dim  swModelDocExt  As  ModelDocExtension
    Dim  swFeatureManager  As  FeatureManager
    Dim  swRefPlane  As  RefPlane
    Dim  swSketchManager  As  SketchManager
    Dim  swSketchSegment  As  SketchSegment
    Dim  swFeature  As  Feature
    Dim  swLoftFeatureData  As  LoftFeatureData
    Dim  pointArray  As  Object
    Dim  points()  As  Double
    Dim  guideCurves  As  Object
    Dim  guideCurve  As  Object
    Dim  nbrGuideCurves  As  Integer
    Dim  i  As  Integer
    Dim  status  As  Boolean
 
    Public  Sub  Main()
 
        'Open  new  part  document 
        swModel  =  swApp.**NewDocument**("C:\ProgramData\SolidWorks\SolidWorks  2015\templates\Part.prtdot",  0,  0,  0)
        swModelDocExt  =  swModel.**Extension**
 
        'Create  reference  plane
        status  =  swModelDocExt.**SelectByID2**("Right  Plane",  "PLANE",  0,  0,  0,  True,  0,  Nothing,  0)
        swFeatureManager  =  swModel.**FeatureManager**
        swRefPlane  =  swFeatureManager.**InsertRefPlane**(8,  0.0635,  0,  0,  0,  0)
        swModel.**ClearSelection2**(True)
 
        'Create  circle  for  loft  feature
        status  =  swModelDocExt.**SelectByID2**("Plane1",  "PLANE",  0,  0,  0,  True,  0,  Nothing,  0)
        swSketchManager  =  swModel.**SketchManager**
        swSketchManager.**InsertSketch**(True)
        swSketchSegment  =  swSketchManager.**CreateCircle**(-0.0#,  0.0#,  0.0#,  0.003857,  -0.009744,  0.0#)
        swModel.**ClearSelection2**(True)
        swSketchManager.**InsertSketch**(True)
 
        'Create  another  circle  for  loft  feature
        status  =  swModelDocExt.**SelectByID2**("Right  Plane",  "PLANE",  0,  0,  0,  False,  0,  Nothing,  0)
        swSketchManager  =  swModel.**SketchManager**
        swSketchManager.**InsertSketch**(True)
        swSketchSegment  =  swSketchManager.**CreateCircle**(-0.0#,  0.0#,  0.0#,  0.014007,  -0.029232,  0.0#)
        swModel.**ClearSelection2**(True)
        swSketchManager.**InsertSketch**(True)
 
        'Create  sketch  for  guide  curve
        status  =  swModelDocExt.**SelectByID2**("Front  Plane",  "PLANE",  0,  0,  0,  False,  0,  Nothing,  0)
        swModel.**ClearSelection2**(True)
        ReDim  points(8)
        points(0)  =  0
        points(1)  =  0.0324150959148675
        points(2)  =  0
        points(3)  =  0.02176137524458
        points(4)  =  0.0209549481725162
        points(5)  =  0
        points(6)  =  0.0635
        points(7)  =  0.0104797609372824
        points(8)  =  0
        pointArray  =  points
        swSketchManager.**InsertSketch**(True)
        swSketchSegment  =  swSketchManager.**CreateSpline**((pointArray))
        swSketchManager.**InsertSketch**(True)
 
        'Create  loft  feature  with  guide  curve
        status  =  swModelDocExt.**SelectByID2**("Sketch1",  "SKETCH",  0,  0,  0,  True,  0,  Nothing,  0)
        status  =  swModelDocExt.**SelectByID2**("Sketch2",  "SKETCH",  0,  0,  0,  True,  0,  Nothing,  0)
        status  =  swModelDocExt.**SelectByID2**("Sketch3",  "SKETCH",  0,  0,  0,  True,  0,  Nothing,  0)
        swModel.**ClearSelection2**(True)
        status  =  swModelDocExt.**SelectByID2**("Sketch1",  "SKETCH",  0.0635,  0,  -0.0104797609372824,  False,  1,  Nothing,  0)
        status  =  swModelDocExt.**SelectByID2**("Sketch2",  "SKETCH",  0,  0,  -0.0324150959148675,  True,  1,  Nothing,  0)
        status  =  swModelDocExt.**SelectByID2**("Sketch3",  "SKETCH",  0,  0,  0,  True,  4098,  Nothing,  0)
        swFeature  =  swFeatureManager.**InsertProtrusionBlend2**(False,  True,  False,  1,  0,  0,  1,  1,  True,  True,  False,  0,  0,  0,  True,  True,  True,  swGuideCurveInfluence_e.swGuideCurveInfluenceNextGlobal)
        Debug.Print("Feature:")
        Debug.Print("  Type:  "  &  swFeature.**GetTypeName2**)
        Debug.Print("  Name:  "  &  swFeature.**Name**)
 
        'Change  the  orientation  of  the  view
        swModel.**ShowNamedView2**("*Isometric",  7)
 
        'Access  loft  feature  data,  get  guide  curves,
        'get  feature  type  of  guide  curves,  and  release
        'access  to  loft  feature
        swLoftFeatureData  =  swFeature.**GetDefinition**
        Debug.Print("    Boss  feature:  "  &  swLoftFeatureData.**IsBossFeature**)
```

--------------------------------

### Preconditions and Postconditions for Drawing Sheet Example

Source: https://help.solidworks.com/2026/english/api/sldworksapi/Get_Sheet_in_Multi-Sheet_Drawing_Example_VBNET.htm

These comments outline the setup steps required to run the example, including opening a specific sample file, and describe the expected behavior in the Immediate window.

```vbnet
'----------------------------------------------------------------------
' Preconditions:
' 1. Click **File > Open**.
' 2. Open _public_documents_**\samples\tutorial\advdrawings\foodprocessor.sldrw**.
' 3. Click **Select sheets to open > Selected > Sheet1* (load) > OK  >Open**.
' 4. Open the Immediate window.
'
' Postconditions:
' 1. Loads Sheet1 only.
' 2. Mouse over Sheet2, Sheet3, and Sheet4 tabs and examine the
'    Immediate window.
'
' NOTE: Because this drawing is used elsewhere, do not save changes.
'---------------------------------------------------------------------
```

--------------------------------

### Preconditions and Setup

Source: https://help.solidworks.com/2026/english/api/draftsightapi/Get_and_Set_Document_Settings_Example_CSharp.htm

Instructions for setting up the Visual C# Console App project and required references.

```text
//--------------------------------------------------------------
//Preconditions:
// 1. Create a Visual C# Console App (.NET Framework) in Visual Studio.
// 2. Copy and paste this code into the program file.
// 3. Add a reference to:
//    _install_dir_**\APISDK\tlb\DraftSight.Interop.dsAutomation.dll**.
// 4. Start DraftSight and open a drawing.
// 5. Add references to **System** and **System.Windows.Forms**.
// 6. Start debugging the project.
//
//Postconditions: Message boxes pop up verifying that
//document properties are reset. Read the text in each
//message box before clicking OK to close it.
//----------------------------------------------------------------
```

--------------------------------

### Get Guide Curves in Sweep Feature VBA Example

Source: https://help.solidworks.com/2026/english/api/sldworksapi/Get_Guide_Curves_in_Sweep_Feature_Example_VB.htm

This complete VBA script creates a sweep feature with a guide curve and retrieves the guide curve information. Ensure the part template path is correct for your environment before running.

```vba
'---------------------------------------------------
' Preconditions: 
' 1. Verify that the part template exists.
' 2. Open the Immediate window.
'
' Postconditions:
' 1. Creates a new part document.
' 2. Creates a sweep feature.
' 3. Gets the number of guide curves in the sweep
'    feature.
' 4. Accesses the guide curves in the sweep feature.
' 5. Gets the feature types of the guide curves.
' 6. Releases access of the sweep feature.
' 7. Examine the Immediate window.
'---------------------------------------------------
Option Explicit
```

```vba
Dim swApp As SldWorks.SldWorks
Dim swModel As SldWorks.ModelDoc2
Dim swModelDocExt As SldWorks.ModelDocExtension
Dim swSketchMgr As SldWorks.SketchManager
Dim swSketchSegment As SldWorks.SketchSegment
Dim swFeature As SldWorks.Feature
Dim swFeatureMgr As SldWorks.FeatureManager
Dim swSweepFeatureData As SldWorks.SweepFeatureData
Dim pointArray As Variant
Dim points() As Double
Dim guideCurves As Variant
Dim guideCurve As Object
Dim nbrGuideCurves As Long
Dim status As Boolean
Dim i As Long
```

```vba
Sub main()
```

```vba
    Set swApp = Application.SldWorks
```

```vba
    'Create new model document
    Set swModel = swApp.**NewDocument**("C:\ProgramData\SolidWorks\SolidWorks 2017\templates\Part.prtdot", 0, 0, 0)
    Set swModelDocExt = swModel.**Extension**
```

```vba
    'Sketch an ellipse for sweep profile
    swModel.**ClearSelection2** True
    Set swSketchMgr = swModel.**SketchManager**
    status = swModelDocExt.**SelectByID2**("Top Plane", "PLANE", 0, 0, 0, False, 0, Nothing, 0)
    swSketchMgr.**InsertSketch** True
    Set swSketchSegment = swSketchMgr.**CreateEllipse**(0, 0, 0, -0.064925207354862, 0, 0, 0, -3.60377802938881E-02, 0)
    swModel.**ClearSelection2** True
    swSketchMgr.**InsertSketch** True
```

```vba
    'Sketch a line for sweep path
    status = swModelDocExt.**SelectByID2**("Front Plane", "PLANE", 0, 0, 0, False, 0, Nothing, 0)
    swSketchMgr.**InsertSketch** True
    Set swSketchSegment = swSketchMgr.**CreateLine**(0#, 0#, 0#, 0#, 0.059816, 0#)
    swModel.**ClearSelection2** True
    swSketchMgr.**InsertSketch** True
```

```vba
    'Sketch a spline for sweep guide curve
    status = swModelDocExt.**SelectByID2**("Front Plane", "PLANE", 0, 0, 0, False, 0, Nothing, 0)
    swSketchMgr.**InsertSketch** True
```

```vba
    ReDim points(0 To 5) As Double
    points(0) = -0.064925207354862
    points(1) = 0
    points(2) = 0
    points(3) = -5.76005360247873E-03
    points(4) = 5.95205538922803E-02
    points(5) = 0
    pointArray = points
    Set swSketchSegment = swSketchMgr.**CreateSpline**((pointArray))
    swModel.**ClearSelection2** True
```

```vba
    status = swModelDocExt.**SelectByID2**("Unknown", "MANIPULATOR", -4.81685228359519E-02, 1.68573405240843E-02, 0, False, 0, Nothing, 0)
    swModel.**ClearSelection2** True
    swSketchMgr.**InsertSketch** True
    swModel.**ViewZoomtofit2**
```

```vba
    'Select the profile, path, and guide curve
    status = swModelDocExt.**SelectByID2**("Sketch1", "SKETCH", 0, 0, 0, True, 0, Nothing, 0)
    status = swModelDocExt.**SelectByID2**("Sketch2", "SKETCH", 0, 0, 0, True, 0, Nothing, 0)
    status = swModelDocExt.**SelectByID2**("Sketch3", "SKETCH", 0, 0, 0, True, 0, Nothing, 0)
    swModel.**ClearSelection2** True
    status = swModelDocExt.**SelectByID2**("Sketch1", "SKETCH", 0, 0, 0, False, 1, Nothing, 0)
    status = swModelDocExt.**SelectByID2**("Sketch2", "SKETCH", 0, 0, 0, True, 4, Nothing, 0)
    status = swModelDocExt.**SelectByID2**("Sketch3", "SKETCH", 0, 0, 0, True, 2, Nothing, 0)
```

```vba
    'Create the sweep feature
    Set swFeatureMgr = swModel.**FeatureManager**
    Set swFeature = swFeatureMgr.**InsertProtrusionSwept4**(False, False, swTwistControlType_e.swTwistControlFollowPath, False, False, swTangencyType_e.swTangencyNone, swTangencyType_e.swTangencyNone, False, 0, 0, swThinWallType_e.swThinWallOneDirection, 0, True, True, True, 0, True, False, 0, 0)
    Debug.Print "Feature type: " & swFeature.**GetTypeName2**
```

```vba
    'Change the orientation of the view
    swModel.**ShowNamedView2** "*Isometric", 7
```

--------------------------------

### GetEndParams Method (IInfiniteLine)

Source: https://help.solidworks.com/2026/english/api/draftsightapi/Interop.dsAutomation~Interop.dsAutomation.IInfiniteLine~GetEndParams.html

Gets the start and end parameters of the InfiniteLine. The method is available in multiple languages as shown in the syntax examples.

```APIDOC
## GetEndParams Method (IInfiniteLine)

### Description
Gets the start and end parameters of the InfiniteLine.

### Syntax

#### Visual Basic (Declaration)
```vb
Sub GetEndParams( _
   DOUBLE*  _StartParameter_ As System.Double, _
   DOUBLE* _EndParameter_ As System.Double _
)
```

#### C#
```csharp
void GetEndParams( 
   out System.double  _StartParameter_,
   out System.double _EndParameter_
)
```

#### JavaScript
```javascript
GetEndParams( 
) : {
    _StartParameter_ : Number,
   _EndParameter_ : Number
}
```

#### COM native C++
```cpp
HRESULT GetEndParams( 
   double*  _StartParameter_,
   double* _EndParameter_
)
```

#### C++
```cpp
DSRESULT GetEndParams( 
   DOUBLE*  _StartParameter_,
   DOUBLE* _EndParameter_
)
```

### Parameters
- **_StartParameter** [out] - Value of start parameter
- **_EndParameter** [out] or Return Value - Value of end parameter

### See Also
- IInfiniteLine Interface
- IInfiniteLine Members
- IInfiniteLine::EvaluateAtParameter Method
- IInfiniteLine::EvaluateAtPoint Method
- IInfiniteLine::GetClosestPointOn Method

### Availability
DraftSight V1R1.3
```

--------------------------------

### C# Command Options Example Setup

Source: https://help.solidworks.com/2026/english/api/draftsightapi/Get_and_Set_Command_Options_Example_CSharp.htm

Initial setup including required namespaces and the main module structure for the DraftSight C# console application.

```csharp
//------------------------------------------------------------
// Preconditions:
// 1. Create a C# Windows console project.
// 2. Copy and paste this example into the C# IDE.
// 3. Add a reference to:
//    _install_dir_\A**PISDK\tlb\DraftSight.Interop.dsAutomation.dll**.
// 4. Add a reference to **System**.
// 5. Open the Immediate window.
// 6. Start DraftSight and open a document.
// 7. Run the macro.
//
// Postconditions: Specified command option values are returned, set, and
// printed to the Immediate window. Results of setting specified command
// option values are also printed to the Immediate window.
//----------------------------------------------------------------
using DraftSight.Interop.dsAutomation;
using System;
using System.Runtime.InteropServices;
using System.Diagnostics;
```

```csharp
static class Module1
{
    public static void Main()
	{
		DraftSight.Interop.dsAutomation.Application dsApp;
		Document dsDoc = default(Document);
```

--------------------------------

### VBA: Get Mate Definition - Preconditions and Option Explicit

Source: https://help.solidworks.com/2026/english/api/sldworksapi/Get_Mate_Definition_Example_VB.htm

This snippet sets up the VBA module with Option Explicit and documents the preconditions and postconditions for the example. It is the starting point for the mate definition retrieval example.

```VBA
'-----------------------------------------------
' Preconditions:
' 1. Open an assembly document containing mates.
' 2. Select a mate.
' 3. Open the Immediate window.
'
' Postconditions:
' 1. Gets the mate definition.
' 2. Examine the Immediate window.
'-----------------------------------------------
Option Explicit

```

--------------------------------

### Main Simulation Setup

Source: https://help.solidworks.com/2026/english/api/swsimulationapi/Get_Free_Body_Forces_and_Moments_Example_CSharp.htm

Main routine to open the model, initialize the Simulation add-in, and prepare the active document for analysis.

```csharp
public void Main()  
{  
ModelDoc2 Part = default(ModelDoc2);  
  
CosmosWorks COSMOSWORKS = default(CosmosWorks);  
CwAddincallback COSMOSObject = default(CwAddincallback);  
CWModelDoc ActDoc = default(CWModelDoc);  
CWStudyManager StudyMngr = default(CWStudyManager);  
CWStudy Study = default(CWStudy);  
CWMesh CWMesh = default(CWMesh);  
CWStaticStudyOptions StudyOptions = default(CWStaticStudyOptions);  
CWResults CWFeatObj = default(CWResults);  
ModelDocExtension ActDocExt = default(ModelDocExtension);  
  
string sModelName = null;  
string sStudyName = null;  
string sStudyConfig = null;  
  
int longstatus = 0;  
int longwarnings = 0;  
int errCode = 0;  
  
double el = 0;  
double el_hold = 0;  
double tl = 0;  
double tl_hold = 0;  
  
double UResMax = 0;  
double Tol1 = 0;  
  
bool bStudyFound = false;  
  
object[] DispArray1 = new object[1];  
object[] DispArray2 = new object[1];  
object[] Force = null;  
int iMeshUnit = 0;  
int iSolverType = 0;  
int iNumberOfStudies = 0;  
int ix = 0;  
int iStudyType = 0;  
  
sModelName = "public_documents\\\samples\\\tutorial\api\\\Remoteload.sldprt";  
  
//SOLIDWORKS configuration that study is active under (Blank "" = use default)  
sStudyConfig =  "";  
sStudyName = "Study 1";  
  
iSolverType = (int)swsSolverType_e.swsSolverTypeFFEPlus;  
  
Hashtable PIDCollection = new Hashtable();  
PIDCollection = PIDInitializer();  
  
Part = swApp.**OpenDoc6**(sModelName, (int)swDocumentTypes_e.swDocPART, 1, "", ref longstatus, ref longwarnings);  
if (Part == null) ErrorMsg(swApp, "Failed to open: " + sModelName);  
  
// Get the SOLIDWORKS Simulation object   
COSMOSObject = (CwAddincallback)swApp.**GetAddInObject**("SldWorks.Simulation");  
if (COSMOSObject == null) ErrorMsg(swApp, "COSMOSObject object not found.");  
COSMOSWORKS = (CosmosWorks)COSMOSObject.**CosmosWorks** ;  
if (COSMOSWORKS == null) ErrorMsg(swApp, "COSMOSWORKS object not found.");  
  
//Get active document  
ActDoc = COSMOSWORKS.**ActiveDoc** ;  
if (ActDoc == null) ErrorMsg(swApp, "No active document");  
  
//If needed, rebuild the model  
ActDocExt = Part.**Extension** ;
```

--------------------------------

### Configure Cable Parameters and Run Analysis

Source: https://help.solidworks.com/2026/english/api/swsimulationapi/SolidWorks.Interop.cosworks~SolidWorks.Interop.cosworks.ICWCable.html

This example demonstrates how to set cable parameters, assign materials, create a mesh, run a simulation analysis, and verify connector forces.

```vb
If errCode <> 0 Then ErrorMsg2 SwApp, "Cable-2 SetOffsetAtEnd2 failed", True
errCode = CWCable.**SetCableParams**(0.02, 2400, 0#)
If errCode <> 0 Then ErrorMsg2 SwApp, "Cable-2 SetCableParams failed", True
CWCable.**MaterialSource** = 1
CWCable.**SetLibraryMaterial** strMaterialLib, "Alloy Steel"
errCode = CWCable.**EndEdit**()
If errCode <> 0 Then ErrorMsg2 SwApp, "Cable-2 EndEdit failed", True
' Select the second pair of items to connect by cable; select faces only for solid bodies; select edges for shells
boolstatus = Part.Extension.**SelectByRay**(0.373018956619831, 1.17464121526402, 1.33263008238066, -0.34176252876859, -0.236529471640091, 0.909534047177652, 9.80012553162479E-04, 2, True, 0, 0)
boolstatus = Part.Extension.**SelectByRay**(0.644518640365447, 0.841241138500749, 1.33311291616565, -0.34176252876859, -0.236529471640091, 0.909534047177652, 1.69346169186476E-03, 2, True, 0, 0)
Part.GraphicsRedraw2
Set StudyObj = StudyManagerObj.GetStudy(0)
Set LoadsAndRestraintsManagerObj = StudyObj.LoadsAndRestraintsManager()
Set DispatchObj1 = Part.SelectionManager.GetSelectedObject6(1, -1)
Set DispatchObj2 = Part.SelectionManager.GetSelectedObject6(2, -1)
DispArray = Array(DispatchObj1)
DispArray2 = Array(DispatchObj2)
Set CWCable2 = LoadsAndRestraintsManagerObj.**AddCable**((DispArray), (DispArray2), 0, errCode)
If errCode <> 0 Then ErrorMsg2 SwApp, "Cable-3 creation failed", True
Set CWCable2 = LoadsAndRestraintsManagerObj.**GetCable**("Cable-3", errCode)
CWCable2.BeginEdit
errCode = CWCable2.**SetFlipOffsetDirAtEnd1**(0)
If errCode <> 0 Then ErrorMsg2 SwApp, "Cable-3 SetFlipOffsetDirAtEnd1 failed", True
errCode = CWCable2.**SetOffsetAtEnd1**(0.01)
If errCode <> 0 Then ErrorMsg2 SwApp, "Cable-3 SetOffsetAtEnd1 failed", True
errCode = CWCable2.**SetFlipOffsetDirAtEnd2**(0)
If errCode <> 0 Then ErrorMsg2 SwApp, "Cable-3 SetFlipOffsetDirAtEnd2 failed", True
errCode = CWCable2.**SetOffsetAtEnd2**(0.01)
If errCode <> 0 Then ErrorMsg2 SwApp, "Cable-3 SetOffsetAtEnd2 failed", True
errCode = CWCable2.**SetCableParams**(0.02, 2400, 0#)
If errCode <> 0 Then ErrorMsg2 SwApp, "Cable-3 SetCableParams failed", True
CWCable2.**MaterialSource** = 1
CWCable2.**SetLibraryMaterial** strMaterialLib, "Alloy Steel"
errCode = CWCable2.**EndEdit**()
If errCode <> 0 Then ErrorMsg2 SwApp, "Cable-3 EndEdit failed", True
Part.ClearSelection2 True
'Mesh
Set CWMesh = StudyObj.**Mesh**
If CWMesh Is Nothing Then ErrorMsg2 SwApp, "No Mesh Object", False
CWMesh.Quality = 1
CWMesh.MesherType = 0 '2 'BCB
Call CWMesh.GetDefaultElementSizeAndTolerance(0, el, tl)
errCode = StudyObj.CreateMesh(0, el, tl)
If errCode <> 0 Then ErrorMsg2 SwApp, "Mesh failed", True
'Run Analysis
errCode = StudyObj.**RunAnalysis**
If errCode <> 0 Then ErrorMsg2 SwApp, "Analysis failed", True
Part.GraphicsRedraw2
'Get results
Set CWResult = StudyObj.**Results**
If CWResult Is Nothing Then ErrorMsg2 SwApp, "No Result Object", False
'Get connector results/Force
Dim Force1, Force2 As Variant
Force1 = CWResult.**GetConnectorForces2**(1, "Cable-2", 0, errCode)
Force2 = CWResult.**GetConnectorForces2**(1, "Cable-3", 0, errCode)
Connector_Force1 = 1380 'Expected axial force (comp = 7)
Connector_Force2 = 1390 'Expected axial force (comp = 7)
Tol1 = 0.1
Dim i As Integer
For i = 0 To 10
Debug.Print i & " : " & Force1(i)
SwApp.RecordLine "'******** Cable-2 Force " & i & " : " & Force1(i) & " ********"
Next i
If errCode <> 0 Then ErrorMsg2 SwApp, "No connector force", True
If ((Force1(7)) < 0.95 * Connector_Force1) Or ((Force1(7)) > 1.05 * Connector_Force1) Then
ErrorMsg2 SwApp, "O/p Force % error = " & (((Force1(7) - Connector_Force1) / Connector_Force1) * 100), False
End If
For i = 0 To 10
Debug.Print i & " : " & Force2(i)
SwApp.RecordLine "'******** Cable-3 Force " & i & " : " & Force2(i) & " ********"
Next i
If errCode <> 0 Then ErrorMsg2 SwApp, "No connector force", True
If ((Force2(7)) < 0.95 * Connector_Force2) Or ((Force2(7)) > 1.05 * Connector_Force2) Then
ErrorMsg2 SwApp, "O/p Force % error = " & (((Force2(7) - Connector_Force2) / Connector_Force2) * 100), False
End If
End Sub
Function ErrorMsg2(SwApp As Object, Message As String, EndTest As Boolean)
SwApp.SendMsgToUser2 Message, 0, 0
SwApp.RecordLine "'*** WARNING - General"
SwApp.RecordLine "'*** " & Message
SwApp.RecordLine ""
End Function
```

--------------------------------

### Get Guide Curves in Loft Feature C# Example

Source: https://help.solidworks.com/2026/english/api/sldworksapi/Get_Guide_Curves_in_Loft_Feature_Example_CSharp.htm

This code creates a part, builds a loft feature with a guide curve, and prints details about the feature and its guide curves to the Immediate window. Ensure the specified part template path exists before running.

```csharp
//----------------------------------------
// Preconditions:
// 1. Verify that the specified part document
//    template exists.
// 2. Open the Immediate window.
//
// Postconditions:
// 1. Creates a new part document.
// 2. Creates a loft feature.
// 3. Prints to the Immediate window
//    the feature type and feature name of the loft 
//    feature.
// 4. Accesses the guide curves in the loft feature.
// 5. Prints to the Immediate window whether the
//    loft is a boss feature, the number guide
//    curves in the loft, and the feature types of 
//    the guide curves.
// 6. Releases access to the loft feature.
// 7. Examine the Immediate window.
//----------------------------------------
using SolidWorks.Interop.sldworks;
using SolidWorks.Interop.swconst;
using System.Runtime.InteropServices;
using System;
using System.Diagnostics;
 
namespace LoftGuideCurveCSharp.csproj
{
    public partial class SolidWorksMacro
    {
 
        ModelDoc2 swModel;
        ModelDocExtension swModelDocExt;
        FeatureManager swFeatureManager;
        RefPlane swRefPlane;
        SketchManager swSketchManager;
        SketchSegment swSketchSegment;
        Feature swFeature;
        LoftFeatureData swLoftFeatureData;
        object pointArray = null;
        double[] points = null;
        object[] guideCurves = null;
        object guideCurve;
        int nbrGuideCurves;
        int[] guideCurvesTypes = null;
        int guideCurveType = 0;
        int i = 0;
        bool status = false;
 
        public void Main()
        {
            //Open new part document
            swModel = (ModelDoc2)swApp.NewDocument("C:\\ProgramData\\SolidWorks\\SolidWorks 2015\\templates\\Part.prtdot", 0, 0, 0);
            swModelDocExt = (ModelDocExtension)swModel.Extension;
 
            //Create reference plane
            status = swModelDocExt.SelectByID2("Right Plane", "PLANE", 0, 0, 0, true, 0, null, 0);
            swFeatureManager = (FeatureManager)swModel.FeatureManager;
            swRefPlane = (RefPlane)swFeatureManager.InsertRefPlane(8, 0.0635, 0, 0, 0, 0);
            swModel.ClearSelection2(true);
 
            //Create circle for loft feature
            status = swModelDocExt.SelectByID2("Plane1", "PLANE", 0, 0, 0, true, 0, null, 0);
            swSketchManager = (SketchManager)swModel.SketchManager;
            swSketchManager.InsertSketch(true);
            swSketchSegment = (SketchSegment)swSketchManager.CreateCircle(-0.0, 0.0, 0.0, 0.003857, -0.009744, 0.0);
            swModel.ClearSelection2(true);
            swSketchManager.InsertSketch(true);
 
            //Create another circle for loft feature
            status = swModelDocExt.SelectByID2("Right Plane", "PLANE", 0, 0, 0, false, 0, null, 0);
            swSketchManager.InsertSketch(true);
            swSketchSegment = (SketchSegment)swSketchManager.CreateCircle(-0.0, 0.0, 0.0, 0.014007, -0.029232, 0.0);
            swModel.ClearSelection2(true);
            swSketchManager.InsertSketch(true);
 
            //Create sketch for guide curve
            status = swModelDocExt.SelectByID2("Front Plane", "PLANE", 0, 0, 0, false, 0, null, 0);
            swModel.ClearSelection2(true);
            points = new double[9];
            points[0] = 0;
            points[1] = 0.0324150959148675;
            points[2] = 0;
            points[3] = 0.02176137524458;
            points[4] = 0.0209549481725162;
            points[5] = 0;
            points[6] = 0.0635;
            points[7] = 0.0104797609372824;
            points[8] = 0;
            pointArray = points;
            swSketchManager.InsertSketch(true);
            swSketchSegment = swSketchManager.CreateSpline((pointArray));
            swSketchManager.InsertSketch(true);
 
            //Create loft feature with guide curve
            status = swModelDocExt.SelectByID2("Sketch1", "SKETCH", 0, 0, 0, true, 0, null, 0);
            status = swModelDocExt.SelectByID2("Sketch2", "SKETCH", 0, 0, 0, true, 0, null, 0);
            status = swModelDocExt.SelectByID2("Sketch3", "SKETCH", 0, 0, 0, true, 0, null, 0);
            swModel.ClearSelection2(true);
            status = swModelDocExt.SelectByID2("Sketch1", "SKETCH", 0.0635, 0, -0.0104797609372824, false, 1, null, 0);
            status = swModelDocExt.SelectByID2("Sketch2", "SKETCH", 0, 0, -0.0324150959148675, true, 1, null, 0);
            status = swModelDocExt.SelectByID2("Sketch3", "SKETCH", 0, 0, 0, true, 4098, null, 0);
            swFeature = (Feature)swFeatureManager.InsertProtrusionBlend2(false, true, false, 1, 0, 0, 1, 1, true, true, false, 0, 0, 0, true, true, true, (int)swGuideCurveInfluence_e.swGuideCurveInfluenceNextGlobal);
            Debug.Print("Feature:");
```

--------------------------------

### Preconditions and Postconditions for RichLine Example

Source: https://help.solidworks.com/2026/english/api/draftsightapi/Construct_RichLine_Example_VBNET.htm

Lists the required setup steps: create a VB.NET console project, paste the example, add a reference to DraftSight.Interop.dsAutomation.dll, start DraftSight with an open document, and debug. The postcondition is a message box when a RichLine is constructed.

```VB.NET
'--------------------------------------------------------------
' Preconditions:
' 1. Create a VB.NET Windows console project.
' 2. Copy and paste this example into the VB.NET IDE.
' 3. Add a reference to:
'    _install_dir_\**APISDK\tlb\DraftSight.Interop.dsAutomation.dll**.
' 4. Start DraftSight and open a document.
' 5. Start debugging the project.
'
' Postconditions: A message box pops up when a RichLine is
' constructed in the drawing document. 
'----------------------------------------------------------------

```

--------------------------------

### VBA Preconditions and Postconditions

Source: https://help.solidworks.com/2026/english/api/sldworksapi/Get_External_References_Example_VB.htm

Lists the setup requirements and expected output for the external references example.

```text
'-------------------------------------------
'  Preconditions:
'  1. Open an assembly or part document.
'  2. Select:
'     * a component in an assembly document.
'       - or -
'     * a feature in an assembly or part document.
'       - or -
'     * Nothing in either type of document.
'
' Postconditions: Examine the Immediate window
' to see the name of the part or assembly document
' and the external references for the 
' selected component, selected feature, or
' document.
'-------------------------------------------
```

--------------------------------

### Get Free Body Forces and Moments Example (VB.NET)

Source: https://help.solidworks.com/2026/english/api/swsimulationapi/Get_Free_Body_Forces_and_Moments_Example_VBNET.htm

This code provides the necessary setup and helper functions to interact with SOLIDWORKS Simulation, including verification utilities and PID-based entity selection.

```vbnet
Imports SolidWorks.Interop.sldworks
Imports SolidWorks.Interop.swconst
Imports SolidWorks.Interop.cosworks
Imports System.Runtime.InteropServices
Imports System
Imports System.Diagnostics

Partial Class SolidWorksMacro

Function VerifyLong(ByVal SwApp As SldWorks, ByVal lExpected As Long, ByVal lActual As Long, ByVal sMessage As String) As Boolean
'This function will compare two long values for equivalence.
'If they are different, an error message is reported with {sMessage}
'as title, and the function returns false.
'If equivalent, the function returns true.
VerifyLong =  True
If lActual <> lExpected Then
ErrorMsg(SwApp, sMessage & ": Expected = " & CStr(lExpected) & " , Actual = " & CStr(lActual))
VerifyLong = False
End If
End Function

Function VerifyTolerance(ByVal SwApp As SldWorks, ByVal dExpected As Double, ByVal dActual As Double, ByVal dTol As Double,  ByVal sMessage As String)  As Boolean
'This function will compare two double values to ensure that the actual
'value is within the specified tolerance range
'of the expected value. If the actual is not within the tolerance range,
'an error message is reported with {sMessage}
'as title, and the function returns false. Otherwise, the function returns
'true to indicate equivalence/success.
VerifyTolerance =  True
If (dActual < ((1 - dTol) * dExpected)) Or (dActual > ((1 + dTol) * dExpected)) Then
ErrorMsg(SwApp, sMessage & ": Expected = " & CStr(dExpected) & " , Actual = " & CStr(dActual) & " , Tolerance = " & CStr(dTol) & " percent")
VerifyTolerance = False
End If
End Function

Function SelectByPID(ByVal Part As ModelDoc2, ByVal PIDName As String, ByVal PIDCollection As Collection) As Object
Dim PID() As Byte
Dim PIDVariant As Object
Dim PIDString As String
Dim i As Integer
Dim SelObj As Object

'Get the string from the collection
PIDString =  ""
PIDString = PIDCollection.Item(PIDName)

'Parse the string into an array
PIDVariant = Split(PIDString, ",")
ReDim PID(UBound(PIDVariant))

'Change to a byte array
For i = 0 To (UBound(PIDVariant) - 1)
PID(i) = PIDVariant(i)
Next i

'Select the entity
SelObj = Part.**Extension**.**GetObjectByPersistReference**((PID))
SelectByPID = SelObj
SelObj = Nothing
End Function

Function PIDInitializer() As Collection
Dim PIDCollection As New Collection
Dim selection1 As String

'Constants
selection1 =  "35,29,213,113,218,129,72,162,168,88,152,178,27,137,239,153,161,1,0,0,16,1,0,0,120,1,109,80,77,75,195,64,20,156,42,181,181,234,65,40,232,197,163,224,69,239,182,232,197,84,44,20,34,155,30,60,8,33,110,54,98,219,36,18,183,224,69,200,143,232,111,240,230,69,252,7,30,253,79,141,243,92,226,7,184,135,157,125,51,243,102,121,175,215,5,86,1,84,203,138,55,177,106,96,3,105,126,30,105,163,76,18,234,198,23,13,52,5,197,201,243,244,190,216,127,25,190,142,107,116,109,59,210,86,228,105,48,181,131,204,6,243,34,25,198,202,220,135,218,201,107,34,171,80,203,15,91,124,15,30,173,127,51,49,218,58,106,155,212,89,96,139,187,236,246,34,202,226,153,33,189,172,14,60,244,112,141,75,20,200,49,129,129,134,101,29,32,101,61,101,45,90,68,213,226,129,111,69,70,20,75,28,17,35,196,56,162,123,4,143,62,133,49,214,75,166,118,254,243,173,0,31,39,125,31,184,218,237,28,186,57,221,205,134,150,199,192,132,113,115,204,24,94,159,231,214,49,246,88,188,157,246,125,217,143,140,214,149,209,178,88,246,247,103,5,205,178,253,23"
selection1 = selection1 & "7,173,119,10,108,150,220,236,47,165,78,254,193,79,249,139,99,22,0,0,0,0,0,0,0,0"
selection1 = selection1 & ",Type=1"

'Store constants in a collection
PIDCollection.Add(selection1, "selection1")

Dim selection2 As String

'Constants
```

--------------------------------

### Linear Pattern Preconditions and Postconditions

Source: https://help.solidworks.com/2026/english/api/draftsightapi/Create_Linear_Pattern_Example_CSharp.htm

Lists the necessary setup steps, including project references and environment requirements, as well as the expected outcome of the script.

```text
//-------------------------------------------------------------
// Preconditions:
// 1. Create a C# Windows console project.
// 2. Copy and paste this example into the C# IDE.
// 3. Add a reference to:
//    _install_dir_\**APISDK\tlb\DraftSight.Interop.dsAutomation.dll.
**// 4. Add references to **System** and **System.Windows.Forms**.
// 5. Start DraftSight and open a document.
// 6. Click Start Debugging.
//
// Postconditions: 
// 1. Draws a Circle.
// 2. Draws a 2D PolyLine.
// 3. Creates a linear pattern using the Circle and 2D PolyLine 
//    entities.
// 4. Zooms the drawing to fit.
// 5. Examine the drawing.
//------------------------------------------------------------
```

--------------------------------

### Get Mass Properties Examples

Source: https://help.solidworks.com/2026/english/api/swsimulationapi/SolidWorks.Interop.cosworks~SolidWorks.Interop.cosworks.ICWMassPropertiesManager.html?id=11.4.1.38

Examples for getting mass properties using VBA, VB.NET, and C#.

```APIDOC
## Get Mass Properties Examples

### Description
Examples for getting mass properties using VBA, VB.NET, and C#.

### Examples
- Get Mass Properties (VBA)
- Get Mass Properties (VB.NET)
- Get Mass Properties (C#)
```
Tokens:
Raw