Hide Table of Contents

Get External References (VB.NET)

This example shows how to get a list of the external references for a selected component, selected feature, or document.

'  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
' component, selected feature, or document.
Imports SolidWorks.Interop.sldworks
Imports SolidWorks.Interop.swconst
Imports System
Imports System.Diagnostics

Partial Class SolidWorksMacro

Public Sub main()

Dim swModel As ModelDoc2
Dim swModDocExt As ModelDocExtension
Dim swSelMgr As SelectionMgr
Dim swFeat As Feature
Dim swComp As Component2
Dim vModelPathName As Object = Nothing
        Dim vComponentPathName As Object = Nothing
        Dim vFeature As Object = Nothing
        Dim vDataType As Object = Nothing
        Dim vStatus As Object = Nothing
        Dim vRefEntity As Object = Nothing
        Dim vFeatComp As Object = Nothing
        Dim nConfigOpt As Integer
        Dim sConfigName As String
        Dim nRefCount As Integer
        Dim nSelType As Integer
        Dim i As Integer

        swApp = CreateObject("SldWorks.Application")
        swModel = swApp.ActiveDoc
        swSelMgr = swModel.SelectionManager

        swModDocExt = swModel.Extension
        nSelType = swSelMgr.GetSelectedObjectType3(1, -1)

Select Case nSelType

' Selected component in an assembly
            Case swSelectType_e.swSelCOMPONENTS
                swComp = swSelMgr.GetSelectedObjectsComponent3(1, -1)
                nRefCount = swComp.ListExternalFileReferencesCount
                swComp.ListExternalFileReferences2(vModelPathName, vComponentPathName, vFeature, vDataType, vStatus, vRefEntity, vFeatComp, nConfigOpt, sConfigName)

                swModel = swComp.GetModelDoc2

' Selected feature in a part or assembly
            Case swSelectType_e.swSelBODYFEATURES, swSelectType_e.swSelSKETCHES
                swFeat = swSelMgr.GetSelectedObject6(1, -1)
                nRefCount = swFeat.ListExternalFileReferencesCount
                swFeat.ListExternalFileReferences2(vModelPathName, vComponentPathName, vFeature, vDataType, vStatus, vRefEntity, vFeatComp, nConfigOpt, sConfigName)

' Part document only
            Case Else
                nRefCount = swModDocExt.ListExternalFileReferencesCount
                swModDocExt.ListExternalFileReferences(vModelPathName, vComponentPathName, vFeature, vDataType, vStatus, vRefEntity, vFeatComp, nConfigOpt, sConfigName)

End Select

        Debug.Print("Model name = " + swModel.GetPathName)
"    Reference count        = " + Str(nRefCount))
For i = 0 To nRefCount - 1
"    Model path + name      = " + vModelPathName(i))
"    Component path + name  = " + vComponentPathName(i))
"    Feature                = " + vFeature(i))
"    Data type              = " + vDataType(i))
"    Status                 = " + Str(vStatus(i)))
"    Reference entity       = " + vRefEntity(i))
"    Feature component      = " + vFeatComp(i))
Next i

"    Configuration option   = " & nConfigOpt)
"    Configuration name     = " & sConfigName)

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:   Get External References (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) 2012 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.