Get External References Example (VB.NET)
This example shows how to get
all of the external references for the base part using the SolidWorks Document Manager API.
'----------------------------------------------------------------------------
' Preconditions:
' 1. Read the SolidWorks Document Manager API
' Getting Started topic and ensure that the
' required DLLs have been registered.
' 2. Copy and paste this code into a VB.NET console application
' in Microsoft Visual Studio.
' 3. Modify the path to the specified assembly.
' 4. Add the SolidWorks.Interop.swdocumentmgr.dll
' reference to the project:
' a. Right-click the solution in Solution Explorer.
' b. Select Add Reference.
' c. Click Browse.
' d. Select:
' <SolidWorks_install_dir>\api\redist\SolidWorks.Interop.swdocumentmgr.dll
' 5. Substitute <your_license_code> with your
' SolidWorks Document Manager license key.
' 6. Ensure that c:\temp exists.
' Postconditions:
' 1. Inspect the Immediate Window for the external references and
their
'
configurations.
' 2. Inspect c:\temp\extRef.xml for more information about
the external
'
references.
'--------------------------------------------------------------------------
Imports
SolidWorks.Interop.swdocumentmgr
Imports
System
Imports
System.Diagnostics
Module
Module1
Dim
dmClassFact As
SwDMClassFactory
Dim
dmDocMgr As
SwDMApplication3
Dim
dmDoc As
SwDMDocument15
Dim
dmDocType As
SwDmDocumentType
Dim
dmSearchOpt As
SwDMSearchOption
Dim
status As
SwDmDocumentOpenError
Dim
dmExtRefOption As
SwDMExternalReferenceOption
Dim
numExtRefs As
Long
Dim
xmlError As Long
Const
docPath As
String
= "<SolidWorks_install_dir>\samples\tutorial\api\assembly-with-mirrored-component.sldasm"
Const
licenseKey As
String
= "<your_license_code>"
Sub main()
setDocType()
dmClassFact = CreateObject("SwDocumentMgr.SwDMClassFactory")
dmDocMgr = dmClassFact.GetApplication(licenseKey)
dmDoc = dmDocMgr.GetDocument(docPath, dmDocType,
True,
status)
If
Not
(dmDoc Is
Nothing)
Then
NewMethod()
dmDoc.GetXmlStream("c:\temp\extRef.xml",
xmlError)
dmDoc.CloseDoc()
Else
Debug.Print("Unable
to open document. Check 'docPath' variable path.")
End
If
End
Sub
Sub
NewMethod()
dmExtRefOption = dmDocMgr.GetExternalReferenceOptionObject
dmSearchOpt = dmDocMgr.GetSearchOptionObject
dmExtRefOption.SearchOption = dmSearchOpt
dmExtRefOption.Configuration =
"Default"
dmExtRefOption.NeedSuppress
= True
numExtRefs = dmDoc.GetExternalFeatureReferences(dmExtRefOption)
Debug.Print("External
references:")
PrintStrings("FilePath",
dmExtRefOption.ExternalReferences)
Debug.Print("")
Debug.Print("Configurations
of external references:")
PrintStrings("ConfigName",
dmExtRefOption.ReferencedConfigurations)
dmSearchOpt = Nothing
dmExtRefOption =
Nothing
End
Sub
Sub
setDocType()
Dim
typeStr As
String
typeStr = Mid$(docPath,
(Len(docPath) + 1 - 6), 6)
typeStr = UCase$(typeStr)
If
(typeStr = "SLDPRT")
Then
dmDocType =
SwDmDocumentType.swDmDocumentPart
ElseIf
(typeStr = "SLDASM")
Then
dmDocType =
SwDmDocumentType.swDmDocumentAssembly
End
If
End
Sub
Sub
PrintStrings(ByVal
name As
String,
ByVal
varInp As
Object)
Dim
I As
Long
For
I = LBound(varInp) To
UBound(varInp)
Dim
str As
String
str = varInp(I)
Debug.Print(name &
" : "
& str)
Next
I
End
Sub
End
Module