Hide Table of Contents

Create and Edit Bolt and Pin Connectors (VB.NET)

This example shows how to:

  • add a bolt connector to the Connections in a SolidWorks Simulation static study, using persistent reference identifier (PIDs) for entity selections.

  • change the bolt connector's default values, apply library material, and set pre-load.

  • edit an existing pin connector connection.

The model used in this example had four extrudes (three bosses and one cut resulting in four holes), a static study with a Pin Connector-1 connection, and looked like this:


NOTE: To get persistent reference identifiers (PIDs) for model selections, you can use pidcollector.exe or IModelDocExtension::GetPersistReference3.


' Preconditions:

' 1. Add the SolidWorks Simulation as an add-in

'    (in SolidWorks, click Tools > Add-ins > SolidWorks Simulation).

' 2. Add the SolidWorks Simulation primary interop assembly as

'    a reference (in the IDE's Project Explorer, right-click

'    the project name, select Add Reference, click the Browse tab,

'    navigate to the install_dir\api\redist\CLR2 folder and

'    select SolidWorks.Interop.cosworks.dll).

' 3. Model shown is the active document in SolidWorks.

' 4. Modify path to solidworks materials.sldmat if needed.

' 5. Run the macro.


' Postconditions: A bolt connector called Counterbore with Nut-2

'     is added to the study.



Imports SolidWorks.Interop.sldworks

Imports SolidWorks.Interop.swconst

Imports SolidWorks.Interop.cosworks

Imports System

Imports System.Diagnostics


Partial Class SolidWorksMacro


    Public Sub main()


        Dim Part As ModelDoc2

        Dim COSMOSWORKS As Object

        Dim COSMOSObject As CwAddincallback

        Dim ActDoc As CWModelDoc

        Dim StudyMngr As CWStudyManager

        Dim Study As CWStudy

        Dim LBCMgr As CWLoadsAndRestraintsManager

        Dim CWBolt As CWBoltConnector

        Dim CWPin As CWPinConnector

        Dim errCode As Long

        Dim var1 As Object = Nothing

        Dim var2 As Object = Nothing

        Dim pDisp1 As Object = Nothing

        Dim pDisp2 As Object = Nothing

        Dim PIDCollection As New Collection


        PIDCollection = PIDInitializer()


        ' Get SolidWorks Simulation object

        COSMOSObject = swApp.GetAddInObject("SldWorks.Simulation")

        If COSMOSObject Is Nothing Then ErrorMsg(swApp, "COSMOSObject object not found.", True)

        COSMOSWORKS = COSMOSObject.CosmosWorks

        If COSMOSWORKS Is Nothing Then ErrorMsg(swApp, "COSMOSWORKS object not found.", True)


        ' Get active SolidWorks part document

        Part = swApp.ActiveDoc

        ActDoc = COSMOSWORKS.ActiveDoc()


        ' Get study manager and study

        StudyMngr = ActDoc.StudyManager()

        Study = StudyMngr.GetStudy(0)


        ' Get PIDs for the selections

        ' Edge of a hole

        SelectByPID("selection1", PIDCollection, var1)

        ' Opposite edge of same hole

        SelectByPID("selection2", PIDCollection, var2)


        pDisp1 = Part.Extension.GetObjectByPersistReference3((var1), errCode)

        pDisp2 = Part.Extension.GetObjectByPersistReference3((var2), errCode)


        ' Create and initialize object array

        Dim DispArray1 As Object() = {pDisp1}

        Dim DispArray2 As Object() = {pDisp2}


        ' Get loads and restraints manager

        LBCMgr = Study.LoadsAndRestraintsManager


        ' Add bolt connector

        CWBolt = LBCMgr.AddBoltConnector(swsBoltType_e.swsBoltTypeStandardOrCounterboreNut, (DispArray1), (DispArray2), errCode)


        ' Edit bolt connector


        CWBolt.HeadDiameterUnit = 0

        CWBolt.HeadDiameterValue = 5

        CWBolt.BoltShankDiameterUnit = 0

        CWBolt.BoltShankDiameterValue = 2.9

        CWBolt.MaterialType = 1

        CWBolt.SetLibraryMaterial("c:\Program Files\SolidWorks Corp\SolidWorks\lang\english\sldmaterials\solidworks materials.sldmat", "Ductile Iron (SN)")

        CWBolt.BoltUnit = 0

        CWBolt.PreLoadForceType = 0

        CWBolt.PreLoadForceValue = 0.85

        CWBolt.FrictionValue = 0.3

        errCode = CWBolt.BoltConnectorEndEdit


        ' Get Pin Connector-1 connection

        CWPin = LBCMgr.GetLoadsAndRestraints(0, errCode)


        'Edit Pin Connector-1 connection


        CWPin.IncludeTypeWithKey = False

        CWPin.IncludeTypeWithRetainerRing = False

        CWPin.Unit = 0

        CWPin.AxialStiffnessValue = 1000

        CWPin.RotationalStiffnessValue = 10000000.0#

        errCode = CWPin.PinConnectorEndEdit

    End Sub


    Private Sub SelectByPID(ByVal PIDName As String, ByVal PIDCollection As Collection, ByRef varEntity As Object)

        ' Select by PID

        Dim PID() As Byte

        Dim PIDVariant As Object

        Dim PIDString As String

        Dim i As Integer


        ' 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 the array to a byte array

        For i = 0 To (UBound(PIDVariant) - 1)

            PID(i) = Convert.ToByte(PIDVariant(i))

        Next i


        varEntity = PID

    End Sub


    Public Function PIDInitializer() As Collection

        ' Initialize PIDs

        Dim PIDCollection As New Collection

        Dim selection1 As String

        Dim selection2 As String


        ' Constants

        selection1 = "35,29,213,113,218,129,72,162,168,88,152,178,27,137,239,153,184,1,0,0,17,1,0,0,120,1,157,80,189,78,195,48,24,188,242,87,42,64,136,13,169,11,12,172,8,149,9,24,105,163,68,20,129,146,142,72,81,112,156,210,82,59,40,184,18,11,82,38,158,128,7,224,5,88,120,5,102,120,10,158,163,230,220,144,169,27,182,228,179,239,190,251,62,157,191,182,129,101,0,118,102,121,18,109,3,27,80,121,47,29,202,80,102,177,104,204,105,96,197,225,82,245,120,254,124,61,120,15,62,6,53,86,182,93,103,211,169,151,8,121,28,104,19,77,139,44,72,67,249,16,139,74,95,163,238,133,177,112,35,182,92,237,147,185,186,29,75,97,42,106,135,212,121,100,138,145,30,250,137,78,39,146,244,204,238,123,56,197,13,174,81,32,199,24,18,2,6,143,216,67,7,71,220,39,212,212,156,189,67,2,141,17,53,133,67,68,232,163,75,87,136,1,90,37,251,180,22,171,24,230,231,66,248,168,19,254,5,117,95,209,236,178,103,198,142,83,76,56,175,94,29,94,212,165,240,157,227,237,165,242,185,52,109,151,172,200,85,116,111,122,218,44,132,95,45,215,113,70,203,55,173,77,16"

        selection1 = selection1 & "2,229,34,96,179,4,254,163,57,239,47,9,100,114,100,0,0,0,0,0,0,0,0"

        selection1 = selection1 & ",Type=1"

        selection2 = "35,29,213,113,218,129,72,162,168,88,152,178,27,137,239,153,184,1,0,0,20,1,0,0,120,1,157,80,189,78,195,48,24,188,242,87,42,64,136,13,137,5,6,54,132,16,76,192,72,27,37,2,4,74,42,38,164,40,56,78,105,105,28,20,92,137,165,82,38,158,128,7,224,5,88,120,5,102,120,10,158,163,230,92,147,169,27,182,228,207,190,239,187,59,157,191,214,129,121,0,102,98,120,178,154,6,86,144,23,157,180,39,67,153,197,162,49,133,129,5,91,231,220,99,252,249,186,251,30,124,116,235,234,104,91,164,121,101,145,71,15,186,163,244,81,160,116,52,42,179,32,13,229,99,44,220,200,146,29,9,99,97,93,214,172,203,179,190,186,27,72,161,29,180,65,232,44,210,101,95,245,252,68,165,67,73,120,98,118,60,156,224,22,215,40,81,96,0,9,1,141,39,108,227,16,7,220,199,236,229,83,244,30,9,20,250,236,229,216,71,132,11,180,201,10,209,69,171,162,78,107,118,138,121,126,206,133,143,58,228,95,86,251,27,205,54,53,51,42,142,48,164,95,189,78,121,249,190,20,126,147,213,112,89,220,166,217,180,105,84,234,37,66,206,36,95,172,150,177,199,185,27,242,"

        selection2 = selection2 & "172,211,219,139,243,91,173,128,255,244,40,129,95,173,223,107,131,0,0,0,0,0,0,0,0"

        selection2 = selection2 & ",Type=1"


        ' Store constants in a collection

        PIDCollection.Add(selection1, "selection1")

        PIDCollection.Add(selection2, "selection2")


        ' Pass this back

        PIDInitializer = PIDCollection

    End Function


    Private Sub ErrorMsg(ByVal SwApp As Object, ByVal Message As String, ByVal EndTest As Boolean)

        SwApp.SendMsgToUser2(Message, 0, 0)

        SwApp.RecordLine("'*** WARNING - General")

        SwApp.RecordLine("'*** " & Message)


        If EndTest Then

        End If

    End Sub


    ''' <summary>

    ''' The SldWorks swApp variable is pre-assigned for you.

    ''' </summary>

    Public swApp As SldWorks

End Class

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

Subject:   Feedback on Help Topics
Page:   Create and Edit Bolt and Pin Connectors Example (VB.NET)
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:


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

Web Help Content Version: API Help (English only) 2014 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.