Hide Table of Contents

SOLIDWORKS PDM Professional API Help

Get File References for a File Example (VB.NET)

This example shows how to get the file references for a file and export any file references to an XML file. This example also shows how to get whether the file and any file references in local cache are valid or obsolete.



' Preconditions:
'  1. Start Microsoft Visual Studio.
'     a. Click File > New > Project > Visual Basic > Windows Forms Application.
'     b. Type GetFiles2 in Name.
'     c. Click Browse and navigate to the folder where to create 
'        the project.
'     d. Click OK
'     e. Click Show All Files in the Solution Explorer toolbar and expand 
'        Form1.vb in the Solution Explorer.
'     f. Replace the code in Form1.vb with this code.
'     g. To create the form, replace the code in Form1.Designer.vb with this code.
'     h. Right-click the GetFiles2 project name in the Solution Explorer.
'        1. Click Add > Class > Class.
'        2. Type FileRef.vb in Name.
'        3. Click Add.
'        4. Replace the code in FileRef.vb with this code.
'  2. Add EPDM.Interop.epdm.dll as a reference (right-click the project
'     name in the Solution Explorer, click Add > Reference, click 
'     Assemblies > Framework in the left-side panel, browse to the top folder of 
'     your SOLIDWORKS PDM Professional installation, locate and click 
'     EPDM.Interop.epdm.dll, click Add > OK).
'  3. Right-click EPDM.Interop.epdm in References, click Properties, and set 
'     Embed Interop Types to False to handle methods that pass arrays of 
'     structures.
'  4. Verify that C:\temp exists.
'  5. Click Debug > Start Debugging or press F5.
' Postconditions: 
'  1. Displays a dialog.
'  2. Select a vault.
'  3. Click Browse, locate and select a file in the vault that 
'     has file references, and click Open.
'  4. Click Write file references to an XML file, which exports
'     the names of any file references to C:\temp\BatchFileRefInfo.xml.
'  5. Displays a message box that says file references were exported 
'     to an XML file.
'  6. Click OK to close the message box.
'  7. Double-click C:\temp\BatchFileRefInfo.xml and examine its contents.    
Imports System.IO
Imports System.Xml.Serialization
Imports EPDM.Interop.epdm
Public Class Form1
  Dim vault As IEdmVault5 = Nothing
  Private Sub BatchRefTreeInfo_Load(ByVal sender As System.ObjectByVal e As System.EventArgsHandles MyBase.Load
      Dim vault As IEdmVault8 = New EdmVault5
      Dim Views() As EdmViewInfo = {}
      vault.GetVaultViews(Views, False)
      For Each View As EdmViewInfo In Views
      If VaultsComboBox.Items.Count > 0 Then
        VaultsComboBox.Text = VaultsComboBox.Items(0)
      End If
    Catch ex As Runtime.InteropServices.COMException
      MessageBox.Show("HRESULT = 0x" + _
      ex.ErrorCode.ToString("X") + vbCrLf + _
    Catch ex As Exception
    End Try
  End Sub
  Private Sub BrowseButton_Click(ByVal sender As System.ObjectByVal e As System.EventArgsHandles BrowseButton.Click
            'Only create a new vault object
            'if one hasn't been created yet
            If vault Is Nothing Then vault = New EdmVault5
            If Not vault.IsLoggedIn Then
                'Log into selected vault as the current user
                vault.LoginAuto(VaultsComboBox.Text, _
            End If
            'Set the initial directory in the File Open dialog
            BatchRefOpenFileDialog.InitialDirectory = vault.RootFolderPath
            'Show the File Open dialog
            Dim DialogResult As System.Windows.Forms.DialogResult
            DialogResult = BatchRefOpenFileDialog.ShowDialog()
            'If the user didn't click Open, exit the sub
            If Not DialogResult = System.Windows.Forms.DialogResult.OK Then Exit Sub
            For Each FileName As String In BatchRefOpenFileDialog.FileNames
            Next FileName
        Catch ex As Runtime.InteropServices.COMException
      MessageBox.Show("HRESULT = 0x" + _
      ex.ErrorCode.ToString("X") + vbCrLf + _
    Catch ex As Exception
    End Try
  End Sub
  Private Sub GetReferencedFiles( _
    ByVal Reference As IEdmReference10, _
    ByVal FilePath As String, _
    ByVal Level As Integer, _
    ByVal ProjectName As String, _
    ByRef RefFilesDictionary _
    As Dictionary(Of StringString))
            Dim Top As Boolean = False
            If Reference Is Nothing Then
                'This is the first time this function is called for this 
                'file reference tree; i.e., this is the root
                Top = True
                'Add the top-level file path to the dictionary
                RefFilesDictionary.Add(FilePath, Level.ToString())
                Dim File As IEdmFile5 = Nothing
                Dim ParentFolder As IEdmFolder5 = Nothing
                File = vault.GetFileFromPath(FilePath, ParentFolder)
                'Get the file reference tree for this file
                Reference = File.GetReferenceTree(ParentFolder.ID)
                GetReferencedFiles(Reference, "", Level + 1, ProjectName, RefFilesDictionary)
                'Execute this code when this function is called recursively; 
                'i.e., this is not the top-level IEdmReference in the tree
                'Recursively traverse the references
                Dim pos As IEdmPos5
                pos = Reference.GetFirstChildPosition4(ProjectName, Top, TrueTrue, EdmRefFlags.EdmRef_file, "", 0)
                Dim ref As IEdmReference10
                While (Not pos.IsNull)
                    ref = Reference.GetNextChild(pos)
                    RefFilesDictionary.Add(ref.FoundPath, Level.ToString())
                    GetReferencedFiles(ref, "", Level + 1, ProjectName, RefFilesDictionary)
                End While
            End If
        Catch ex As Runtime.InteropServices.COMException
            MessageBox.Show("HRESULT = 0x" + _
            ex.ErrorCode.ToString("X") + vbCrLf + _
        Catch ex As Exception
        End Try
  End Sub
  Private Sub WriteXmlButton_Click( _
    ByVal sender As System.Object, _
    ByVal e As System.EventArgs) _
    Handles WriteXmlButton.Click
            'Only create a new vault object
            'if one hasn't been created yet
            If vault Is Nothing Then vault = New EdmVault5
            If Not vault.IsLoggedIn Then
                'Log into selected vault as the current user
                vault.LoginAuto(VaultsComboBox.Text, Me.Handle.ToInt32())
            End If
            'Get the file paths of all of the referenced files
            'and store them in RefFilesDictionary as keys;
            'the levels where they are found in the file hierarchy 
            'are stored as values
            Dim RefFilesDictionary As Dictionary(Of StringString) = _
                    New Dictionary(Of StringString)()
            For Each FileName As String In BatchRefListBox.Items
                GetReferencedFiles(Nothing, FileName, 0, "A", RefFilesDictionary)
            Next FileName
            'Because selecting a file in the Open File dialog 
            'adds the file and its references to the local cache, 
            'clear the local cache to demonstrate that the 
            'IEdmBatchListing methods don't add the files to 
            'the local cache
            'Declare and create the IEdmClearLocalCache3 object
            Dim ClearLocalCache As IEdmClearLocalCache3
            ClearLocalCache = vault.CreateUtility(EdmUtility.EdmUtil_ClearLocalCache)
	    ClearLocalCache.IgnoreToolboxFiles = True
	    ClearLocalCache.UseAutoClearCacheOption = True
            'Declare and create the IEdmBatchListing object
            Dim BatchListing As IEdmBatchListing4
            BatchListing = vault.CreateUtility(EdmUtility.EdmUtil_BatchList)
            'Add all of the file reference paths to the 
            'IEdmClearLocalCache object to clear from the 
            'local cache and to the IEdmBatchListing object
            'to get the file information in batch mode
            For Each KvPair As KeyValuePair(Of StringStringIn RefFilesDictionary
                DirectCast(BatchListing, IEdmBatchListing4).AddFileCfg(KvPair.Key, Nothing, KvPair.Value, "@"EdmListFileFlags.EdmList_Nothing)
            'Clear the local cache of the file references
            'Create the batch file listing along with the file
            'card variables Description and Number
            Dim BatchListCols() As EdmListCol = Nothing
            DirectCast(BatchListing, IEdmBatchListing4). _
                CreateListEx(vbLf + "Description" + vbLf + _
                    "Number"EdmCreateListExFlags.Edmclef_MayReadFiles, _
                    BatchListCols, Nothing)
            'Get the generated file information
            Dim BatchListFiles() As EdmListFile2 = Nothing
            'Create the list where to store all the file information
            Dim FileRefs As New List(Of FileRef)

            'Recursively add the file information to the list
            AddFileRef(BatchListFiles, 0, 0, FileRefs)
            If Not Directory.Exists("C:\temp"Then
                MessageBox.Show("Directory ""c:\temp"" does " + _
                                "not exist; please create it and try again.")
                'Write out the file references to an XML file
                Dim XmlSer As New XmlSerializer(GetType(List(Of FileRef)))
                Dim StrWriter As New StreamWriter("C:\temp\BatchFileRefInfo.xml")
                XmlSer.Serialize(StrWriter, FileRefs)
                MessageBox.Show( _
                    "File references successfully exported to an XML file.")
            End If
        Catch ex As Runtime.InteropServices.COMException
            MessageBox.Show("HRESULT = 0x" + _
            ex.ErrorCode.ToString("X") + vbCrLf + _
        Catch ex As Exception
        End Try
  End Sub
  Private Sub AddFileRef( _
    ByRef BatchListFiles() As EdmListFile2, _
    ByRef curIndex As Integer, _
    ByVal curLevel As Integer, _
    ByRef FileRefs As List(Of FileRef))
            While curIndex < BatchListFiles.Length
                Dim curListFile As EdmListFile2 = BatchListFiles(curIndex)
                'If the depth level of this listfile is <
                'the current depth level, then...
                If curListFile.mlParam > curLevel Then
                    'Create a new FileRefs list
                    FileRefs(FileRefs.Count - 1).FileRefs = New List(Of FileRef)
                    'Recurse using a new FileRefs list
                    AddFileRef(BatchListFiles, curIndex, curListFile.mlParam, _
                               FileRefs.Item(FileRefs.Count - 1).FileRefs)
                    'Create a new FileRef object to hold
                    'the file information
                    Dim FileRef As New FileRef
                    'Assign the FileRef properties
                    FileRef.CheckedOutBy = curListFile.mbsLockUser
                    FileRef.CurrentState = curListFile.moCurrentState.mbsStateName
                    FileRef.Description = curListFile.moColumnData(0)
                    Dim File As IEdmFile5
                    File = vault.GetObject(EdmObjectType.EdmObject_File, curListFile.mlFileID)
                    FileRef.FileName = File.Name
                    FileRef.LatestRevision = curListFile.mbsRevisionName
                    FileRef.LatestVersion = curListFile.mlLatestVersion
                    FileRef.Number = curListFile.moColumnData(1)
                    FileRef.FileRefs = Nothing
                    'Add the FileRef to this level's list
                    curIndex += 1
                End If
            End While
        Catch ex As Runtime.InteropServices.COMException
            MessageBox.Show("HRESULT = 0x" + _
            ex.ErrorCode.ToString("X") + vbCrLf + _
        Catch ex As Exception
        End Try
  End Sub
End Class
<Global.Microsoft.VisualBasic.CompilerServices.DesignerGenerated()> _
Partial Class Form1
    Inherits System.Windows.Forms.Form
    'Form overrides dispose to clean up the component list.
    <System.Diagnostics.DebuggerNonUserCode()> _
    Protected Overrides Sub Dispose(ByVal disposing As Boolean)
            If disposing AndAlso components IsNot Nothing Then
            End If
        End Try
    End Sub
    'Required by the Windows Form Designer.
    Private components As System.ComponentModel.IContainer
    'NOTE: The following procedure is required by the Windows Form Designer
    'It can be modified using the Windows Form Designer.  
    'Do not modify it using the code editor.
    <System.Diagnostics.DebuggerStepThrough()> _
    Private Sub InitializeComponent()
        Me.BrowseButton = New System.Windows.Forms.Button()
        Me.VaultsComboBox = New System.Windows.Forms.ComboBox()
        Me.VaultsLabel = New System.Windows.Forms.Label()
        Me.BatchRefOpenFileDialog = New System.Windows.Forms.OpenFileDialog()
        Me.BatchRefListBox = New System.Windows.Forms.ListBox()
        Me.BatchRefLabel = New System.Windows.Forms.Label()
        Me.WriteXmlButton = New System.Windows.Forms.Button()
        Me.BrowseButton.Location = New System.Drawing.Point(180, 65)
        Me.BrowseButton.Margin = New System.Windows.Forms.Padding(2)
        Me.BrowseButton.Name = "BrowseButton"
        Me.BrowseButton.Size = New System.Drawing.Size(64, 19)
        Me.BrowseButton.TabIndex = 17
        Me.BrowseButton.Text = "Browse..."
        Me.BrowseButton.UseVisualStyleBackColor = True
        Me.VaultsComboBox.FormattingEnabled = True
        Me.VaultsComboBox.Location = New System.Drawing.Point(16, 32)
        Me.VaultsComboBox.Margin = New System.Windows.Forms.Padding(2)
        Me.VaultsComboBox.Name = "VaultsComboBox"
        Me.VaultsComboBox.Size = New System.Drawing.Size(136, 21)
        Me.VaultsComboBox.TabIndex = 15
        Me.VaultsLabel.AutoSize = True
        Me.VaultsLabel.Location = New System.Drawing.Point(16, 16)
        Me.VaultsLabel.Margin = New System.Windows.Forms.Padding(2, 0, 2, 0)
        Me.VaultsLabel.Name = "VaultsLabel"
        Me.VaultsLabel.Size = New System.Drawing.Size(91, 13)
        Me.VaultsLabel.TabIndex = 16
        Me.VaultsLabel.Text = "Select vault view:"
        Me.BatchRefOpenFileDialog.InitialDirectory = "C:\"
        Me.BatchRefOpenFileDialog.Multiselect = True
        Me.BatchRefListBox.FormattingEnabled = True
        Me.BatchRefListBox.Location = New System.Drawing.Point(18, 94)
        Me.BatchRefListBox.Margin = New System.Windows.Forms.Padding(2)
        Me.BatchRefListBox.Name = "BatchRefListBox"
        Me.BatchRefListBox.Size = New System.Drawing.Size(218, 56)
        Me.BatchRefListBox.TabIndex = 18
        Me.BatchRefLabel.AutoSize = True
        Me.BatchRefLabel.Location = New System.Drawing.Point(16, 71)
        Me.BatchRefLabel.Margin = New System.Windows.Forms.Padding(2, 0, 2, 0)
        Me.BatchRefLabel.Name = "BatchRefLabel"
        Me.BatchRefLabel.Size = New System.Drawing.Size(160, 13)
        Me.BatchRefLabel.TabIndex = 19
        Me.BatchRefLabel.Text = "Files for which to get references:"
        Me.WriteXmlButton.Location = New System.Drawing.Point(19, 169)
        Me.WriteXmlButton.Margin = New System.Windows.Forms.Padding(2)
        Me.WriteXmlButton.Name = "WriteXmlButton"
        Me.WriteXmlButton.Size = New System.Drawing.Size(217, 19)
        Me.WriteXmlButton.TabIndex = 20
        Me.WriteXmlButton.Text = "Write file references to an XML file"
        Me.WriteXmlButton.UseVisualStyleBackColor = True
        Me.AutoScaleDimensions = New System.Drawing.SizeF(6.0!, 13.0!)
        Me.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font
        Me.ClientSize = New System.Drawing.Size(255, 227)
        Me.Margin = New System.Windows.Forms.Padding(2)
        Me.Name = "BatchRefTreeInfo"
        Me.Text = "Get file references"
    End Sub
    Friend WithEvents BrowseButton As System.Windows.Forms.Button
    Friend WithEvents VaultsComboBox As System.Windows.Forms.ComboBox
    Friend WithEvents VaultsLabel As System.Windows.Forms.Label
    Friend WithEvents BatchRefOpenFileDialog As System.Windows.Forms.OpenFileDialog
    Friend WithEvents BatchRefListBox As System.Windows.Forms.ListBox
    Friend WithEvents BatchRefLabel As System.Windows.Forms.Label
    Friend WithEvents WriteXmlButton As System.Windows.Forms.Button
End Class
Public Class FileRef
  Private mLocalOverwittenVersionObsolete As Short
  Private mFileName As String
  Private mLatestVersion As String
  Private mLatestRevision As String
  Private mNumber As String
  Private mDescription As String
  Private mCurrentState As String
  Private mCheckedOutBy As String
  Private mFileRefs As List(Of FileRef)
  Public Sub New()
  End Sub
  Public Property FileName() As String
      Return mFileName
    End Get
    Set(ByVal value As String)
      mFileName = value
    End Set
  End Property
  Public Property LatestVersion() As String
      Return mLatestVersion
    End Get
    Set(ByVal value As String)
      mLatestVersion = value
    End Set
  End Property
  Public Property LatestRevision() As String
      Return mLatestRevision
    End Get
    Set(ByVal value As String)
      mLatestRevision = value
    End Set
  End Property
  Public Property Number() As String
      Return mNumber
    End Get
    Set(ByVal value As String)
      mNumber = value
    End Set
  End Property
  Public Property Description() As String
      Return mDescription
    End Get
    Set(ByVal value As String)
      mDescription = value
    End Set
  End Property
  Public Property CurrentState() As String
      Return mCurrentState
    End Get
    Set(ByVal value As String)
      mCurrentState = value
    End Set
  End Property
  Public Property CheckedOutBy() As String
      Return mCheckedOutBy
    End Get
    Set(ByVal value As String)
      mCheckedOutBy = value
    End Set
  End Property
  Public Property LocalOverwrittenVersionObsolete() As Short
        Return mLocalOverwittenVersionObsolete
    End Get
    Set(ByVal value As Short)
        mLocalOverwittenVersionObsolete = value
    End Set
  End Property
  Public Property FileRefs() As List(Of FileRef)
      Return mFileRefs
    End Get
    Set(ByVal value As List(Of FileRef))
      mFileRefs = value
    End Set
  End Property
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 File References for a File 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) 2024 SP02

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.