Hide Table of Contents

Batch Update Card Variables Example (VB.NET)

This example shows how to update file and folder card variables in one batch.

NOTE: If using the .NET Framework 4.0 primary interop assembly provided with SolidWorks Enterprise PDM, see Using .NET Framework 4.0 in Stand-alone Applications.

' Preconditions:
'  1. Start Microsoft Visual Studio 2012.
'     a. Click File > New > Project > Visual Basic > Windows Forms Application.
'     b. Type BatchUpdateCardVars 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.

'  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 Enterprise PDM installation, locate and click 
'     EPDM.Interop.epdm.dll, click Add, and click 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. Ensure that at least one text file is checked out, and at least one folder
'     with the word Folder in its name exists in the vault.

'  5. Click Debug > Start Debugging or press F5.
' Postconditions: 
'  1. Displays the Batch Update dialog box.

'     a. Select a vault.
'     b. Click Batch Update Variables.
'        * Updates the Title and Comment variables in the data cards
'          only of checked-out text files.
'        * Updates the Description variable of the data cards of all folders
'          with the word Folder in their names.
'        * Displays a message box saying Card variables updated.
'     c. Click OK to close the message box.

'  2. Close the Batch Update dialog box.
'  3. Inspect the data cards of any checked-out text files and folders with
'     the word Folder in their names in the selected vault.


Imports System.IO
Imports System.Xml.Serialization
Imports System.Collections
Imports System.Collections.Generic
Imports System.Data
Imports System.Diagnostics
Imports System.Windows.Forms
Imports System.ComponentModel
Imports EPDM.Interop.epdm
Public Class Form1
    Dim vault1 As IEdmVault5 = New EdmVault5()
    Dim vault As IEdmVault8 = DirectCast(vault1, IEdmVault8)
    Dim Views As EdmViewInfo() = Nothing
    Public Sub Form1_Load(ByVal sender As System.ObjectByVal e As System.EventArgsHandles MyBase.Load
            vault.GetVaultViews(Views, False)
            For Each View As EdmViewInfo In Views
            If VaultsComboBox.Items.Count > 0 Then
                VaultsComboBox.Text = DirectCast(VaultsComboBox.Items(0), String)
            End If
        Catch ex As System.Runtime.InteropServices.COMException
            MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + " " + ex.Message)
        Catch ex As Exception
        End Try
    End Sub
    Private Sub BatchUpdateButton_Click(ByVal sender As System.ObjectByVal e As System.EventArgsHandles BatchUpdateButton.Click
            Dim vault2 As IEdmVault7 = Nothing
            If vault1 Is Nothing Then
                vault1 = New EdmVault5()
            End If
            vault2 = DirectCast(vault1, IEdmVault7)
            If Not vault1.IsLoggedIn Then
                vault1.LoginAuto(VaultsComboBox.Text, Me.Handle.ToInt32())
            End If
            'Create a batch update utility
            Dim Update As IEdmBatchUpdate2
            Update = vault2.CreateUtility(EdmUtility.EdmUtil_BatchUpdate)
            'Get the IDs of the file and folder card variables to update
            Dim TitleID As Integer
            Dim CommentID As Integer
            Dim DescriptionID As Integer
            Dim VariableMgr As IEdmVariableMgr5
            VariableMgr = vault1
            TitleID = VariableMgr.GetVariable("Title").ID
            DescriptionID = VariableMgr.GetVariable("Description").ID
            CommentID = VariableMgr.GetVariable("Comment").ID
            'Search for all text files in the vault
            Dim Search As IEdmSearch5
            Search = vault1.CreateUtility(EdmUtility.EdmUtil_Search)
            Search.FileName = "%.txt"
            Dim Result As IEdmSearchResult5
            Result = Search.GetFirstResult
            While Not Result Is Nothing
                Update.SetVar(Result.ID, TitleID, "My Title"""EdmBatchFlags.EdmBatch_Nothing)
                Update.SetVar(Result.ID, CommentID, "My Comment"""EdmBatchFlags.EdmBatch_Nothing)
                Result = Search.GetNextResult
            End While
            'Search for all folders whose names contain the word Folder in the vault
            Search.FileName = "%Folder%"
            Result = Search.GetFirstResult
            While Not Result Is Nothing
                Update.SetFolderVar(Result.ID, DescriptionID, "My Description"EdmBatchFlags.EdmBatch_Nothing)
                Result = Search.GetNextResult
            End While
            'Write all the card variable values to the database
            Dim Errors() As EdmBatchError2 = Nothing
            Dim errorSize As Integer
            errorSize = Update.CommitUpdate(Errors, Nothing)
            'Display any errors
            Dim Msg As String
            Msg = "Card variables updated."
            Dim ErrName As String = Nothing
            Dim ErrDesc As String = Nothing
            Dim FileName As String = Nothing
            Dim Lo As Integer
            Lo = LBound(Errors)
            Dim Hi As Integer
            Hi = UBound(Errors)

            Dim vault9 As IEdmVault9
            vault9 = DirectCast(vault1, IEdmVault9)
            Dim ppoObjects(Hi) As EdmObjectInfo
            While Lo <= Hi
                ppoObjects(Lo).meType = EdmObjectType.EdmObject_File
                Lo = Lo + 1
            End While

            While Lo <= Hi
                If (Errors(Lo).mlFileID > 0) Then
                    Dim File As IEdmFile6 = Nothing
                    Dim ID As Integer
                    ID = DirectCast(ppoObjects(Lo).moObjectIDInteger)
                    If (ppoObjects(Lo).meType = EdmObjectType.EdmObject_File) _
                       And (ID = Errors(Lo).mlFileIDThen
                        File = DirectCast(ppoObjects(Lo).mpoObjectIEdmFile6)
                        FileName = File.Name
                    End If
                End If
                vault1.GetErrorString(Errors(Lo).mlErrorCode, ErrName, ErrDesc)
                Msg = Msg + vbLf + ErrName + " " + FileName
                Lo = Lo + 1
            End While
        Catch ex As System.Runtime.InteropServices.COMException
            MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + " " + ex.Message)
        Catch ex As Exception
        End Try
    End Sub
End Class

Back to top



<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.BatchUpdateButton = New System.Windows.Forms.Button()
        Me.VaultsComboBox = New System.Windows.Forms.ComboBox()
        Me.Label1 = New System.Windows.Forms.Label()
        Me.BatchUpdateButton.Location = New System.Drawing.Point(30, 100)
        Me.BatchUpdateButton.Name = "BatchUpdateButton"
        Me.BatchUpdateButton.Size = New System.Drawing.Size(215, 23)
        Me.BatchUpdateButton.TabIndex = 0
        Me.BatchUpdateButton.Text = "Batch Update Variables"
        Me.BatchUpdateButton.UseVisualStyleBackColor = True
        Me.VaultsComboBox.FormattingEnabled = True
        Me.VaultsComboBox.Location = New System.Drawing.Point(30, 56)
        Me.VaultsComboBox.Name = "VaultsComboBox"
        Me.VaultsComboBox.Size = New System.Drawing.Size(121, 21)
        Me.VaultsComboBox.TabIndex = 1
        Me.Label1.AutoSize = True
        Me.Label1.Location = New System.Drawing.Point(27, 23)
        Me.Label1.Name = "Label1"
        Me.Label1.Size = New System.Drawing.Size(75, 13)
        Me.Label1.TabIndex = 2
        Me.Label1.Text = "Select vault view:"
        Me.AutoScaleDimensions = New System.Drawing.SizeF(6.0!, 13.0!)
        Me.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font
        Me.ClientSize = New System.Drawing.Size(284, 153)
        Me.Name = "Form1"
        Me.Text = "Batch Update"
    End Sub
    Friend WithEvents BatchUpdateButton As System.Windows.Forms.Button
    Friend WithEvents VaultsComboBox As System.Windows.Forms.ComboBox
    Friend WithEvents Label1 As System.Windows.Forms.Label
End Class


Back to top

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:   Batch Update Card Variables 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.